{"openapi":"3.0.3","info":{"title":"BR-DGE Transaction REST API","description":"Use the BR-DGE Transaction REST API to manage and process transactions within BR-DGE. With these endpoints, you can create, retrieve, update and delete transactions securely and efficiently. These unlock access to various third-party payment services such as Payment Service Providers (PSPs), Digital Wallets and Alternative Payment Methods (APMs).\n\nPlease see our [Web SDK documentation] for more information about how we can help you integrate your client applications with us.\n## Authorization\nAPI keys can be generated via the BR-DGE portal and are grouped into two main classes based on their usage:\n- Server API keys for use by you in your secure back-end services, *and must not be exposed to your end users.*\n- Separate Client API keys will be provided for use in client applications to support certain features that need to\n  happen in untrusted client environments.\n\n## Environment Sub Domains\nThe BR-DGE REST API is hosted on a selection of subdomains. Use <https://sandbox.comcarde.com> for testing and either <https://secure.comcarde.com> or <https://secure-amer-01.api.br-dge.io> for live payments depending on your operational region.\n\n**IMPORTANT**: To ensure [PCI Compliance], please only use mock payment instrument data when interacting with our Sandbox API.\n\n[PCI Compliance]: https://www.pcisecuritystandards.org/\n[Web SDK documentation]: https://docs.br-dge.io/docs/web-sdk-introduction\n","version":"v1.0.0","contact":{"name":"Customer Support","url":"https://docs.br-dge.io/docs/support#contact-support"},"license":{"name":"MIT","url":"https://docs.br-dge.io/docs/openapi-license"}},"servers":[{"url":"https://sandbox.comcarde.com/v1","description":"Sandbox subdomain for testing your integration works as expected, using mock payment instruments only.\n"},{"url":"https://secure.comcarde.com/v1","description":"Use this subdomain for processing live payments in the EU region."},{"url":"https://secure-amer-01.api.br-dge.io/v1","description":"Use this subdomain for processing live payments in the NA region."}],"tags":[{"name":"Payments","description":"Collect money from all of your customers."},{"name":"Orders","description":"Create and manage orders for the BR-DGE Hosted Payment Page"},{"name":"Payouts","description":"Send money to your customers"},{"name":"PayPal","description":"Perform payments using PayPal."}],"externalDocs":{"url":"https://docs.br-dge.io"},"paths":{"/payments":{"post":{"tags":["Payments"],"summary":"Create a payment","description":"Request a transfer of funds between accounts at banks or other financial institutions.\n","operationId":"createPaymentUsingPOST","security":[{"ServerApiKey":[]}],"parameters":[{"name":"expand","in":"query","description":"The presence of this field returns extra metadata,\nthat may or may not be attached to the payment.\nThe individual metadata that is returned is implementation dependant\nand different fields may be returned in different areas of the response.\n\nCurrently the only supported parameter is `expand=rawPspResponse`.\n\nParameter values:\n * `rawPspResponse` - Include the `rawPspResponses` array within the `pspInfo`\n   response field, if present within the payment.\n\n   Not all payment solutions are currently supported with rawPspResponse.\n\n   The data that is returned in this field is *NOT* internally controlled\n   and will be different depending on the Payment Solution Provider (PSP).\n\n   We make no guarantees about the information included within the rawPspResponse.\n\n   **See:** Response example `Successful payment with expanded rawPspResponse`\n","schema":{"type":"array","uniqueItems":true,"items":{"type":"string","enum":["rawPspResponse"]}}},{"name":"include","in":"query","description":"A parameter allowing the inclusion of related information.\n\nThis parameter follows closely the [JSON:API Inclusion of Related\nResources]. Specifying valid entries will result in the entities\nbeing included in the `included` section of the response.\n\n[JSON:API Inclusion of Related Resources]: https://jsonapi.org/format/1.1/#fetching-includes\n","schema":{"type":"array","items":{"type":"string","enum":["paymentInstrument","issuerResponse"]},"uniqueItems":true},"explode":false}],"requestBody":{"required":true,"description":"Details of the payment to be initiated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequest"},"examples":{"tokenized-payment":{"$ref":"#/components/examples/payment-request-tokenized"},"card-payment":{"$ref":"#/components/examples/payment-request-card"},"card-payment-create-card-on-file":{"$ref":"#/components/examples/payment-request-card-create-card-on-file"},"paypal-payment":{"$ref":"#/components/examples/payment-request-paypal"},"googlepay-payment":{"$ref":"#/components/examples/payment-request-googlepay"},"applepay-payment":{"$ref":"#/components/examples/payment-request-applepay"},"providerThreeDSecureNonce-payment":{"$ref":"#/components/examples/payment-request-providerThreeDSecureNonce"},"split-auth-and-capture":{"$ref":"#/components/examples/payment-request-split-auth-and-capture"},"ideal-payment":{"$ref":"#/components/examples/payment-request-ideal"},"bancontact-payment":{"$ref":"#/components/examples/payment-request-bancontact"},"trustly-payment":{"$ref":"#/components/examples/payment-request-trustly"},"paysafecard-payment":{"$ref":"#/components/examples/payment-request-paysafecard"},"pix-payment":{"$ref":"#/components/examples/payment-request-pix"},"astropay-payment":{"$ref":"#/components/examples/payment-request-astropay"},"neteller-payment":{"$ref":"#/components/examples/payment-request-neteller"},"oneVoucher-payment":{"$ref":"#/components/examples/payment-request-oneVoucher"},"ottVoucher-payment":{"$ref":"#/components/examples/payment-request-ottVoucher"},"bluVoucher-payment":{"$ref":"#/components/examples/payment-request-bluVoucher"},"revolutpay-payment":{"$ref":"#/components/examples/payment-request-revolutpay"},"tokenized-payment-initial-mit":{"$ref":"#/components/examples/payment-request-tokenized-initial-mit"},"tokenized-payment-subsequent-mit":{"$ref":"#/components/examples/payment-request-tokenized-subsequent-mit"},"PspTokenInstrument":{"$ref":"#/components/examples/payment-request-psp-token"},"riskInstruments":{"$ref":"#/components/examples/payment-request-risk-instruments"},"externalThreeDS-payment":{"$ref":"#/components/examples/payment-request-external-3ds"},"customMetadata-payment":{"$ref":"#/components/examples/payment-request-custom-metadata"},"skrill-payment":{"$ref":"#/components/examples/payment-request-skrill"},"skrill-one-tap-payment":{"$ref":"#/components/examples/payment-request-skrill-one-tap"},"truelayer-payment":{"$ref":"#/components/examples/payment-request-truelayer"},"truelayer-payment-with-bank-details":{"$ref":"#/components/examples/payment-request-truelayer-using-bankDetails"},"bank2bank-payment":{"$ref":"#/components/examples/payment-request-bank2bank"},"aft-payment":{"$ref":"#/components/examples/payment-request-card-aft"}}}}},"responses":{"201":{"description":"Payment request completed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentResponse"},"examples":{"Successful payment":{"$ref":"#/components/examples/payment-response-successful"},"Successful payment with expanded rawPspResponse":{"$ref":"#/components/examples/payment-response-successful-rawPspResponse"},"Successful payment with included paymentInstrument":{"$ref":"#/components/examples/payment-response-successful-included-paymentInstrument"},"Successful ApplePay payment with included paymentInstrument":{"$ref":"#/components/examples/payment-response-successful-apple-pay-included-paymentInstrument"},"Successful payment with new Card on File created":{"$ref":"#/components/examples/payment-response-successful-cof-creation"},"Successful payment with installments plan successfully activated":{"$ref":"#/components/examples/payment-response-successful-installments-plan"},"Successful payment with pspToken and pspCardFingerPrint":{"$ref":"#/components/examples/payment-response-successful-psp-token"},"Successful payment with riskAssessments":{"$ref":"#/components/examples/payment-response-successful-risk-assessment"},"Successful payment with unavailable risk engine":{"$ref":"#/components/examples/payment-response-successful-no-risk-engine"},"Successful payment with included issuerResponse":{"$ref":"#/components/examples/payment-response-successful-issuerResponse"},"Successful AFT payment":{"$ref":"#/components/examples/aft-payment-response-yes"}}}},"links":{"Get status of a Payment":{"operationId":"getPaymentStatusUsingGET","parameters":{"paymentId":"$response.body#/paymentId"},"description":"The `paymentId` value returned in the response can be used as the `paymentId` parameter in `GET /payments/{paymentId}/status`.\n"},"Refund a Payment":{"operationId":"createRefundUsingPOST","parameters":{"paymentId":"$response.body#/paymentId"},"description":"The `paymentId` value returned in the response can be used as the `paymentId` parameter in `POST /payments/{paymentId}/refund`.\n"}}},"202":{"description":"The operation has been accepted for processing and the outcome is not yet known.\nIf an action is in the response, please see [post-response-actions], otherwise please refer to the webhook callbacks that are linked to this operation.\n\n[post-response-actions]: https://docs.br-dge.io/docs/rest-api-introduction#post-response-actions\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentResponse"},"examples":{"Further action required to make 3D-Secure payment":{"$ref":"#/components/examples/payment-response-accepted-3ds-further-action"},"Further action required to make 3-D Secure payment with new Card on File":{"$ref":"#/components/examples/payment-response-accepted-3ds-further-action-include-cof"},"Redirect Flow Action Response":{"$ref":"#/components/examples/payment-response-accepted-redirect-flow"},"Pending":{"$ref":"#/components/examples/payment-response-accepted-pending"},"Pending Skrill":{"$ref":"#/components/examples/payment-response-accepted-pending-skrill"}}}}},"400":{"description":"Bad request - the request was in an invalid format or contained invalid information.\n\nIf have any questions about why you are receiving these responses, please raise a ticket with support on the BR-DGE Support Portal at <https://docs.br-dge.io/docs/support#contact-support> with the `id` from the response so we track down the individual requests on our end.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"Bad request with validation errors":{"$ref":"#/components/examples/bad-request-with-validation-errors"},"Transaction declined due to risk engine's assessment":{"$ref":"#/components/examples/bad-request-payment-declined-risk-assessment"}}}}},"401":{"$ref":"#/components/responses/UnauthorizedRequest"},"409":{"description":"Indicates a request conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DuplicateMerchantTransactionIdError"},"examples":{"Duplicate merchantTransactionId provided":{"value":{"code":"4701","message":"Duplicate Merchant Transaction ID","id":"4fad8e2e06a15656","merchantTransactionId":"yourUniqueRequestId"}}}}}},"422":{"$ref":"#/components/responses/UnprocessableContentRequest"},"500":{"$ref":"#/components/responses/UnknownServerError"},"502":{"$ref":"#/components/responses/BadGatewayNetworkError"}},"callbacks":{"Payment Status Change Events":{"https://example.com/BR-DGE/ as defined in your retail channel config":{"post":{"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentStatusChangeEvent"},"examples":{"authorization-pending":{"$ref":"#/components/examples/authorization-pending"},"authorized":{"$ref":"#/components/examples/authorized"},"authorized-with-payment-instrument-card":{"$ref":"#/components/examples/authorized-payment-instrument-card"},"authorized-with-payment-instrument-apple-pay":{"$ref":"#/components/examples/authorized-payment-instrument-apple-pay"},"authorized-with-payment-instrument-google-pay":{"$ref":"#/components/examples/authorized-payment-instrument-google-pay"},"capture-pending":{"$ref":"#/components/examples/capture-pending"},"captured":{"$ref":"#/components/examples/captured"},"declined":{"$ref":"#/components/examples/declined"},"rejected":{"$ref":"#/components/examples/rejected"},"capture-failed":{"$ref":"#/components/examples/capture-failed"}}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"PSP Token Status Change Event":{"$ref":"#/components/callbacks/PspTokenStatusChangeEvent"},"PSP Token Provisioning Failed Event":{"$ref":"#/components/callbacks/PspTokenProvisioningFailedEvent"},"Network Token Provisioning Failed Event":{"$ref":"#/components/callbacks/NetworkTokenProvisioningFailedEvent"},"Network Token Status Change Event":{"$ref":"#/components/callbacks/NetworkTokenStatusChangeEvent"},"Network Token Metadata Update Event":{"$ref":"#/components/callbacks/NetworkTokenMetadataUpdateEvent"},"Payment Instrument Account Selection Event":{"$ref":"#/components/callbacks/PaymentInstrumentAccountSelectionEvent"}}},"get":{"tags":["Payments"],"summary":"Query Payments","description":"Search for payments","operationId":"getPaymentsUsingGET","security":[{"ServerApiKey":[]}],"parameters":[{"name":"merchantTransactionId","in":"query","required":true,"description":"The unique identifier that was set in `POST /v1/payments`.","schema":{"$ref":"#/components/schemas/MerchantTransactionId"}},{"name":"include","in":"query","description":"A parameter allowing the inclusion of related information.\n\nThis parameter follows closely the [JSON:API Inclusion of Related\nResources]. Specifying valid entries will result in the entities\nbeing included in the `included` section of the response.\n\n[JSON:API Inclusion of Related Resources]: https://jsonapi.org/format/1.1/#fetching-includes\n","schema":{"type":"array","items":{"type":"string","enum":["issuerResponse"]},"uniqueItems":true},"explode":false}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPaymentResponseList"},"examples":{"authorization-pending":{"summary":"Authorization Pending","description":"A transaction has been submitted for Authorization to the Processor and this request has been accepted by the Processor but the outcome has not been determined. (It is anticipated that there will be async update to this status and that this should be a temporary state.)\n","value":[{"code":"1000","message":"Approved","paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","status":"AUTHORIZATION_PENDING","timestamp":"2022-01-30T10:10:10Z","reference":"example-customer-order-code","paymentRails":"VISA","paymentInstrument":{"type":"card","nameOnCard":"John F Doe","pan":"1233 56##","expiryDate":"06-30","fingerprint":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c6","fingerprintExtended":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c60630","cardMetadata":{"cardBrand":"VISA","issuer":"ACMEBANK","type":"DEBIT","category":"CLASSIC","countryIsoA2":"GB","commercial":true,"bin":"45678765"}},"psp":{"name":"Barclaycard Smartpay Fuse","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"}}]},"authorization-pending with Google Pay payment instrument":{"summary":"Authorization Pending with Google Pay Payment Instrument","description":"A transaction has been submitted for Authorization to the Processor and this request has been accepted by the Processor but the outcome has not been determined. (It is anticipated that there will be an async update to this status and that this should be a temporary state.)\n","value":[{"code":"1000","message":"Approved","paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","status":"AUTHORIZATION_PENDING","timestamp":"2022-01-30T10:10:10Z","reference":"example-customer-order-code","paymentInstrument":{"type":"googlePay","decryptedPayload":{"gatewayMerchantId":"some-merchant-id","messageExpiration":"1650574736277","messageId":"AH2Ejtc88ZHJ-2aYBQWzHwvp6l0JsCHgxVt8s91A-ZUikaXNbcjsFm6gg9ExeVR-jzIyT-mJvA_ntvfRsDDOH2jnKMjdTtXIJvPt0NBUU45R7-gnjxkx-sI0ldcWvbDHsV0735yFDbWk","paymentMethod":"CARD","paymentMethodDetails":{"pan":"####-####-####-4444","expirationMonth":5,"expirationYear":2025,"authMethod":"PAN_ONLY","eciIndicator":"07","assuranceDetails":{"accountVerified":true,"cardholderAuthenticated":true}}},"metadata":{"cardBrand":"VISA","issuer":"ACMEBANK","type":"DEBIT","category":"CLASSIC","countryIsoA2":"GB","commercial":true},"expiryDate":"05-25","fingerprint":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c6","fingerprintExtended":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c60525"},"psp":{"name":"Barclaycard Smartpay Fuse","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"}}]},"authorized":{"summary":"Authorized Payment","description":"If BR-DGE receives a PSP notification that one of your transactions has been updated to authorized status then this information will be passed on to you via a BR-DGE callback.\n","value":[{"code":"1000","message":"Approved","paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","status":"AUTHORIZED","timestamp":"2022-01-30T10:10:10Z","reference":"example-customer-order-code","paymentRails":"VISA","paymentInstrument":{"type":"card","nameOnCard":"John F Doe","pan":"1233 56##","expiryDate":"06-30","fingerprint":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c6","fingerprintExtended":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c60630","cardMetadata":{"cardBrand":"VISA","issuer":"ACMEBANK","type":"DEBIT","category":"CLASSIC","countryIsoA2":"GB","commercial":true,"bin":"45678765"}},"psp":{"name":"Barclaycard Smartpay Fuse","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"}}]},"authorized-with-psp-token-payment-instrument":{"summary":"Authorized payment using a pspToken","description":"A successful payment using a PSP Token as the payment instrument will return the PSP token which was used to create the payment as part of the payment response.\n","value":[{"code":"1000","message":"Approved","paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","status":"AUTHORIZED","timestamp":"2022-01-30T10:10:10Z","reference":"example-customer-order-code","paymentInstrument":{"type":"pspToken","token":"ABC123"},"psp":{"name":"Checkout.com","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"}}]},"Payment status with risk assessment information":{"summary":"Payment status with RiskAssessment field included","description":"The riskAssessments field contains information about the outcome of risk assessments performed by risk engines\n","value":[{"code":"1000","message":"Approved","paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","status":"AUTHORIZED","timestamp":"2022-01-30T10:10:10Z","reference":"example-customer-order-code","paymentRails":"VISA","paymentInstrument":{"type":"card","nameOnCard":"John F Doe","pan":"1233 56##","expiryDate":"06-30","cardMetadata":{"cardBrand":"VISA","issuer":"ACMEBANK","type":"DEBIT","category":"CLASSIC","countryIsoA2":"GB","commercial":true,"bin":"45678765"}},"psp":{"name":"Barclaycard Smartpay Fuse","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"},"riskAssessments":{"kount":{"score":90.1,"decision":"APPROVED","transactionId":"KJX50N55NGJS","tags":["SUBSCRIPTION","KNOWN_LOCATION"]}}}]},"captured":{"summary":"Captured Payment","description":"If BR-DGE receives a PSP notification that one of your transactions has been updated to captured status then this information will be passed on to you via a BR-DGE callback.\n","value":[{"code":"1000","message":"Approved","paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","status":"CAPTURED","timestamp":"2022-01-30T10:10:10Z","reference":"example-customer-order-code","paymentRails":"VISA","paymentInstrument":{"type":"applePay"},"psp":{"name":"Barclaycard Smartpay Fuse","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"}}]},"voided":{"summary":"Voided Payment","description":"If BR-DGE receives a PSP notification that one of your transactions has been updated to void status then this information will be passed on to you via a BR-DGE callback.\n","value":[{"code":"1000","message":"Approved","paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","status":"VOIDED","timestamp":"2022-01-30T10:10:10Z","reference":"example-customer-order-code","paymentInstrument":{"type":"payPal"},"psp":{"name":"Trust Payments","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"}}]},"void-error":{"summary":"Error with void request","description":"If BR-DGE receives a PSP notification of an error with your transaction.\n","value":[{"code":"4252","message":"Transaction Error: Maximum number of attempts to process request reached","paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","status":"AUTHORIZED","timestamp":"2022-01-30T10:10:10Z","reference":"example-customer-order-code","paymentInstrument":{"type":"ideal"},"psp":{"name":"Checkout.com","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"}}]},"declined":{"summary":"Declined Payment","description":"A transaction has been submitted for Authorization to the Processor and this request has been processed and declined. The transaction could have either been declined by the Processor, due to rules within their system [Fraud, velocity limits, value limits], or by the Card Issuer. There will be an associated `reason` assigned to this state providing details of the decline.\n","value":[{"code":"4201","message":"Transaction Error: Transaction declined by payment processor - customer will need to contact their bank for more details","paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","status":"AUTHORIZATION_DECLINED","timestamp":"2022-01-30T10:10:10Z","reference":"example-customer-order-code","paymentInstrument":{"type":"bancontact"},"psp":{"name":"Barclaycard Smartpay Fuse","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"}}]},"rejected":{"summary":"Rejected Payment","description":"A transaction has been submitted for Authorization to the processor and this been rejected due to a validation or a technical error. This rejection could have occurred either within the BR-DGE platform, the Processor or the Card Issuer. There will be an associated `reason` assigned to this state providing details of the rejection.\n","value":[{"code":"4251","message":"Transaction Error: Payment was rejected by payment processor","paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","status":"REJECTED","timestamp":"2022-01-30T10:10:10Z","reference":"example-customer-order-code","paymentInstrument":{"type":"card","nameOnCard":"John F Doe","pan":"1233 56##","expiryDate":"06-30","fingerprint":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c6","fingerprintExtended":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c60630","cardMetadata":{"cardBrand":"VISA","issuer":"ACMEBANK","type":"DEBIT","category":"CLASSIC","countryIsoA2":"GB","commercial":true,"bin":"45678765"}},"psp":{"name":"Barclaycard Smartpay Fuse","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"}}]},"capture-or-void-error":{"summary":"Error capturing or voiding an authorized payment","description":"If your transaction was authorized but there was an issue capturing or voiding the transaction.\n","value":[{"code":"4252","message":"Transaction Error: Maximum number of attempts to process request reached","paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","status":"AUTHORIZED","timestamp":"2022-01-30T10:10:10Z","reference":"example-customer-order-code","paymentInstrument":{"type":"card","nameOnCard":"John F Doe","pan":"1233 56##","expiryDate":"06-30","fingerprint":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c6","fingerprintExtended":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c60630","cardMetadata":{"cardBrand":"VISA","issuer":"ACMEBANK","type":"DEBIT","category":"CLASSIC","countryIsoA2":"GB","commercial":true,"bin":"45678765"}},"psp":{"name":"Checkout.com","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"}}]},"Card payment instrument not found":{"value":[{"code":"1000","message":"Approved","paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","status":"CAPTURED","timestamp":"2022-01-30T10:10:10Z","reference":"example-customer-order-code","paymentInstrument":{"type":"card"},"psp":{"name":"Checkout.com","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"}}],"description":"This example occurs when the payment status is returned but the card payment instrument details are unavailable.\n\nThe retrieval of payment instrument details will only be attempted for card payments.\n"},"Payment Status with included issuerResponse":{"summary":"Payment with included issuerResponse","description":"If the parameters ?include=issueResponse are used and the payment has an issuerResponse. IssuerResponses are only captured from Fat Zebra and WorldPay (WPG)\n","value":[{"code":"1000","message":"Approved","paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","paymentRails":"VISA","included":[{"id":"ISSUER_1","type":"issuerResponse","attributes":{"type":"issuerResponse","issuerResponse":{"issuerPaymentMethod":"MasterCard","issuerCardType":"Debit"}}}],"relationships":{"issuerResponse":{"data":{"type":"issuerResponse","id":"ISSUER_1"}}},"psp":{"name":"Fat Zebra","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"}}]},"With cashier Id":{"summary":"Payment made using the Cashier","description":"A transaction submitted through the Cashier will include a cashierId field in the response.\n","value":[{"code":"1000","message":"Approved","paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","status":"CAPTURED","timestamp":"2022-01-30T10:10:10Z","reference":"example-customer-order-code","paymentInstrument":{"type":"paysafecard"},"cashierId":"43ee1f43-df8b-47df-9b7d-33e3f69879b1"}]},"payment-blocked":{"summary":"Payment Blocked","description":"A payment blocked due to routing rules, the blocking rule is provided in the response.\n","value":[{"paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","merchantTransactionId":"65748db8-c794-4bcc-a886-8547e12fe052","code":"4805","message":"Blocked by Routing Rules","timestamp":"2022-01-30T10:10:10Z","paymentInstrument":{"type":"card","nameOnCard":"John F Doe","pan":"1233-56##-####-1133","expiryDate":"06-30","cardMetadata":{"cardBrand":"VISA","issuer":"ACMEBANK","type":"PREPAID","category":"CLASSIC","countryIsoA2":"GB","commercial":true,"bin":"45678765"},"fingerprint":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c6","fingerprintExtended":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c60630"},"status":"BLOCKED","reference":"example-customer-order-code","comcardeCode":{"code":4805,"description":"Blocked by Routing Rules"},"customMetadata":{},"amount":1000,"currencyCode":"GBP","blockingRule":{"name":"Block pre-paid cards"}}]},"No payment could be found":{"value":[]}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/UnauthorizedRequest"},"500":{"$ref":"#/components/responses/UnknownServerError"}}}},"/payments/{paymentId}/capture":{"post":{"tags":["Payments"],"summary":"Capture a payment","operationId":"capturePaymentUsingPOST","security":[{"ServerApiKey":[]}],"parameters":[{"$ref":"#/components/parameters/pathPaymentId"}],"requestBody":{"description":"Details of the payment to be initiated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaptureRequest"}}}},"responses":{"201":{"description":"Transaction captured successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaptureResponse"},"examples":{"Successful capture":{"value":{"code":"1000","message":"Approved","id":"4fad8e2e06a15656","psp":{"name":"Trust Payments","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"}}},"Successful capture with Paysafecard":{"value":{"code":"1000","message":"Approved","id":"4fad8e2e06a15656","psp":{"name":"Paysafecard","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c","additionalInfo":{"type":"paysafecard","customerFirstName":"John","customerLastName":"Smith","customerDateOfBirth":"2000-01-01","customerIpAddress":"0.0.0.0","customerId":"d94d2b0e-6d76-49c8-ab1f-88d1209a8c1b","paysafecardCustomerId":"151743187547"}}}}}}},"links":{"Get status of a Payment":{"operationId":"getPaymentStatusUsingGET","parameters":{"paymentId":"$response.body#/paymentId"},"description":"The `paymentId` value returned in the response can be used as the `paymentId` parameter in `GET /payments/{paymentId}/status`.\n"},"Refund a Payment":{"operationId":"refundPaymentUsingPOST","parameters":{"paymentId":"$response.body#/paymentId"},"description":"The `paymentId` value returned in the response can be used as the `paymentId` parameter in `POST /payments/{paymentId}/refund`.\n"}}},"202":{"description":"Capture request has been accepted for processing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaptureResponse"},"examples":{"Pending Capture":{"value":{"code":"2101","message":"Pending","id":"4fad8e2e06a15656","psp":{"name":"Worldline Online Payments","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/UnauthorizedRequest"},"500":{"$ref":"#/components/responses/UnknownServerError"},"502":{"$ref":"#/components/responses/BadGatewayNetworkError"}},"callbacks":{"Payment Status Change Events":{"$ref":"#/components/callbacks/PaymentStatusChangeEvent"}}}},"/payments/{paymentId}/refund":{"post":{"tags":["Payments"],"summary":"Refund a payment","description":"Initiates a new refund against a previously captured payment\n","operationId":"createRefundUsingPOST","security":[{"ServerApiKey":[]}],"parameters":[{"$ref":"#/components/parameters/pathPaymentId"}],"requestBody":{"description":"Details of the refund to be initiated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundRequest"},"examples":{"partial-refund":{"summary":"Partial Refund (original payment > 1000)","value":{"amount":1000}},"full-refund":{"summary":"Full Refund"},"Full Refund with merchantTransactionId provided":{"value":{"merchantTransactionId":"yourUniqueRequestId"}}}}},"required":false},"responses":{"201":{"description":"Refund request completed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundResponse"},"examples":{"Successful refund":{"value":{"code":"1000","message":"Approved","id":"4fad8e2e06a15656","psp":{"name":"Worldline Online Payments","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"}}},"Successful refund with merchantTransactionId provided":{"value":{"code":"1000","message":"Approved","id":"4fad8e2e06a15656","psp":{"name":"Worldline Online Payments","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"},"merchantTransactionId":"yourUniqueId"}}}}}},"202":{"description":"Pending","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundResponse"},"examples":{"Pending refund":{"value":{"code":"2101","message":"Pending","id":"4fad8e2e06a15656","installmentsPlan":{"provider":"Visa Installments","code":"1000","operation":"cancellation","message":"Approved"},"psp":{"name":"Worldline Online Payments","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/UnauthorizedRequest"},"409":{"description":"Indicates a request conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DuplicateMerchantTransactionIdError"},"examples":{"Duplicate merchantTransactionId provided":{"value":{"code":"4701","message":"Duplicate Merchant Transaction ID","id":"4fad8e2e06a15656","merchantTransactionId":"yourUniqueRequestId"}}}}}},"500":{"$ref":"#/components/responses/UnknownServerError"},"502":{"$ref":"#/components/responses/BadGatewayNetworkError"}},"callbacks":{"Refund status change events":{"https://example.com/BR-DGE/ as defined in your retail channel config":{"post":{"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundStatusChangeEvent"},"examples":{"pending":{"summary":"Refund Pending","description":"The refund request has been recieved and you should expect a further notification\n","value":{"type":"refund","merchantAccountId":"aadf8010-4df3-49c6-96c0-9f175f60ef36","id":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","code":"1000","message":"Approved","status":"PENDING","psp":{"name":"Checkout.com","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c","message":"psp-response"},"hashCode":"90c3b3881074021383c8679f0232580f7b96cebacab77517fc4b479e6d977b06"}},"approved":{"summary":"Refund Approved","description":"Your refund request has been approved","value":{"type":"refund","merchantAccountId":"aadf8010-4df3-49c6-96c0-9f175f60ef36","id":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","code":"1000","message":"Approved","status":"APPROVED","psp":{"name":"Checkout.com","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c","message":"psp-response"},"hashCode":"90c3b3881074021383c8679f0232580f7b96cebacab77517fc4b479e6d977b06","notificationMetadata":{"source":"PSP_WEBHOOK","entity":"REFUND","eventTimestamp":1734000000000}}},"declined":{"summary":"Refund Declined","description":"If a refund is declined the code field should indicate why.\n","value":{"type":"refund","merchantAccountId":"aadf8010-4df3-49c6-96c0-9f175f60ef36","id":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","code":"4252","message":"Maximum retries reached","status":"DECLINED","psp":{"name":"Checkout.com","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c","message":"Transaction Error: Maximum number of attempts to process request reached"},"hashCode":"90c3b3881074021383c8679f0232580f7b96cebacab77517fc4b479e6d977b06"}}}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}}}}},"/payments/{paymentId}/refunds":{"parameters":[{"$ref":"#/components/parameters/pathPaymentId"}],"get":{"tags":["Payments"],"summary":"Get refund(s) from a payment","description":"Returns refund(s) against a payment","operationId":"refundsUsingGET","security":[{"ServerApiKey":[]}],"parameters":[{"name":"merchantTransactionId","in":"query","description":"The unique identifier that is set in `POST /v1/payments/{paymentId}/refund`.","schema":{"$ref":"#/components/schemas/MerchantTransactionId"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRefundsResponseList"},"examples":{"Get refund against a payment":{"value":[{"paymentId":"581c20ef-3a36-4ad9-a11a-88d92a2395eb","status":"PENDING","timestamp":"2024-11-04T14:30:00Z","paymentInstrument":{"type":"card","nameOnCard":"John F Doe","pan":"1233 56##","expiryDate":"06-30","fingerprint":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c6","fingerprintExtended":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c60630","cardMetadata":{"cardBrand":"VISA","issuer":"ACMEBANK","type":"DEBIT","category":"CLASSIC","countryIsoA2":"GB","commercial":true}},"psp":{"name":"Checkout.com","transactionId":"581c20ef-3a36-4ad9-a11a-88d92a2395eb"},"code":"2101","message":"Pending","amount":1000,"merchantTransactionId":"abc123"}]},"Get refunds against a payment":{"value":[{"paymentId":"581c20ef-3a36-4ad9-a11a-88d92a2395eb","status":"PENDING","timestamp":"2024-11-04T14:30:00Z","paymentInstrument":{"type":"card","nameOnCard":"John F Doe","pan":"1233 56##","expiryDate":"06-30","fingerprint":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c6","fingerprintExtended":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c60630","cardMetadata":{"cardBrand":"VISA","issuer":"ACMEBANK","type":"DEBIT","category":"CLASSIC","countryIsoA2":"GB","commercial":true}},"psp":{"name":"Checkout.com","transactionId":"581c20ef-3a36-4ad9-a11a-88d92a2395eb"},"code":"2101","message":"Pending","amount":500},{"paymentId":"fdf60f25-2212-4fdf-b9f0-3dc98ab86847","status":"PENDING","timestamp":"2024-11-04T14:45:00Z","paymentInstrument":{"type":"card","nameOnCard":"John F Doe","pan":"1233 56##","expiryDate":"06-30","fingerprint":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c6","fingerprintExtended":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c60630","cardMetadata":{"cardBrand":"VISA","issuer":"ACMEBANK","type":"DEBIT","category":"CLASSIC","countryIsoA2":"GB","commercial":true}},"psp":{"name":"Checkout.com","transactionId":"fdf60f25-2212-4fdf-b9f0-3dc98ab86847"},"code":"2101","message":"Pending","amount":500}]},"No refund could be found":{"value":[]}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/UnauthorizedRequest"},"500":{"$ref":"#/components/responses/UnknownServerError"}}}},"/payments/{paymentId}/void":{"post":{"tags":["Payments"],"summary":"Void a payment","description":"Perform a Void operation on a payment that has been previously authorized, but not captured or submitted for settlement.\n","operationId":"voidPaymentUsingPOST","security":[{"ServerApiKey":[]}],"parameters":[{"$ref":"#/components/parameters/pathPaymentId"}],"responses":{"201":{"description":"Transaction voided successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoidResponse"},"examples":{"Successful void":{"value":{"code":"1000","message":"Approved","id":"4fad8e2e06a15656","psp":{"name":"Checkout.com","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"}}}}}}},"202":{"description":"Void request has been accepted for processing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoidResponse"},"examples":{"Pending Void":{"value":{"code":"2101","message":"Pending","id":"4fad8e2e06a15656","psp":{"name":"Nuvei","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/UnauthorizedRequest"},"500":{"$ref":"#/components/responses/UnknownServerError"},"502":{"$ref":"#/components/responses/BadGatewayNetworkError"}},"callbacks":{"Payment Status Change Events":{"$ref":"#/components/callbacks/PaymentStatusChangeEvent"}}}},"/payments/{paymentId}/status":{"get":{"tags":["Payments"],"summary":"Get the status of a payment","description":"Returns the status of a payment","operationId":"getPaymentStatusUsingGET","security":[{"ServerApiKey":[]}],"parameters":[{"$ref":"#/components/parameters/pathPaymentId"},{"name":"include","in":"query","description":"A parameter allowing the inclusion of related information.\n\nThis parameter follows closely the [JSON:API Inclusion of Related\nResources]. Specifying valid entries will result in the entities\nbeing included in the `included` section of the response.\n\n[JSON:API Inclusion of Related Resources]: https://jsonapi.org/format/1.1/#fetching-includes\n","schema":{"type":"array","items":{"type":"string","enum":["issuerResponse"]},"uniqueItems":true},"explode":false}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentStatusResponse"},"examples":{"authorization-pending":{"summary":"Authorization Pending","description":"A transaction has been submitted for Authorization to the Processor and this request has been accepted by the Processor but the outcome has not been determined. (It is anticipated that there will be async update to this status and that this should be a temporary state.)\n","value":{"code":"1000","message":"Approved","comcardeCode":{"code":"1000","description":"Approved"},"paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","status":"AUTHORIZATION_PENDING","timestamp":"2022-01-30T10:10:10Z","reference":"example-customer-order-code","amount":1500,"currencyCode":"GBP","paymentInstrument":{"type":"card","nameOnCard":"John F Doe","pan":"1233 56## #### 1133","expiryDate":"06-30","fingerprint":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c6","fingerprintExtended":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c60630","cardMetadata":{"cardBrand":"VISA","issuer":"ACMEBANK","type":"DEBIT","category":"CLASSIC","countryIsoA2":"GB","commercial":true,"bin":"45678765"}},"psp":{"name":"Barclaycard Smartpay Fuse","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"}}},"authorization-pending with Google Pay payment instrument":{"summary":"Authorization Pending with Google Pay Payment Instrument","description":"A transaction has been submitted for Authorization to the Processor and this request has been accepted by the Processor but the outcome has not been determined. (It is anticipated that there will be an async update to this status and that this should be a temporary state.)\n","value":{"code":"1000","message":"Approved","comcardeCode":{"code":"1000","description":"Approved"},"paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","status":"AUTHORIZATION_PENDING","timestamp":"2022-01-30T10:10:10Z","reference":"example-customer-order-code","amount":1500,"currencyCode":"GBP","paymentInstrument":{"type":"googlePay","decryptedPayload":{"gatewayMerchantId":"some-merchant-id","messageExpiration":"1650574736277","messageId":"AH2Ejtc88ZHJ-2aYBQWzHwvp6l0JsCHgxVt8s91A-ZUikaXNbcjsFm6gg9ExeVR-jzIyT-mJvA_ntvfRsDDOH2jnKMjdTtXIJvPt0NBUU45R7-gnjxkx-sI0ldcWvbDHsV0735yFDbWk","paymentMethod":"CARD","paymentMethodDetails":{"pan":"####-####-####-4444","expirationMonth":5,"expirationYear":2025,"authMethod":"PAN_ONLY","eciIndicator":"07","assuranceDetails":{"accountVerified":true,"cardholderAuthenticated":true}}},"metadata":{"cardBrand":"VISA","issuer":"ACMEBANK","type":"DEBIT","category":"CLASSIC","countryIsoA2":"GB","commercial":true},"expiryDate":"05-25","fingerprint":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c6","fingerprintExtended":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c60525"},"psp":{"name":"Barclaycard Smartpay Fuse","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"}}},"captured with ApplePay payment instrument":{"summary":"Captured payment with ApplePay Payment Instrument","value":{"code":"1000","message":"Approved","comcardeCode":{"code":"1000","description":"Approved"},"paymentId":"f050f567-e2e0-4122-9e80-8f01e416c5d5","status":"CAPTURED","timestamp":"2026-09-01T08:59:16Z","reference":"b95c82f6-820a-48e8-8363-23fef0ff3760","amount":15100,"currencyCode":"GBP","paymentInstrument":{"type":"applePay","metadata":{"issuer":"INTL HDQTRS-CENTER OWNED","type":"CREDIT","category":"VISA CLASSIC","countryIsoA2":"CN","commercial":false,"bin":"48185288"},"expiryDate":"01-30","fingerprint":"39100e8c5e24ddaff2deb2714403c8fe0b687e9b0a56fafd4e9eac5b13d80973","fingerprintExtended":"39100e8c5e24ddaff2deb2714403c8fe0b687e9b0a56fafd4e9eac5b13d809730130","decryptedPayload":{"applicationPrimaryAccountNumber":"4818528810104376","applicationExpirationDate":"300131","currencyCode":"826","transactionAmount":100,"deviceManufacturerIdentifier":"040010030273","paymentDataType":"3DSecure","paymentData":{"eciIndicator":7},"transactionId":"40110f5b2ddc2ae725eef131caceed8bcdf48b5795df79f0dd804e26946a98c5","cardholderName":"John Doe"},"paymentMethod":{"displayName":"Visa 0189","network":"Visa","type":"credit"}},"psp":{"name":"Nuvei","transactionId":"7110000000028353111"},"scaDetails":{"eci":"07"}}},"authorized":{"summary":"Authorized Payment","description":"If BR-DGE receives a PSP notification that one of your transactions has been updated to authorized status then this information will be passed on to you via a BR-DGE callback.\n","value":{"code":"1000","message":"Approved","comcardeCode":{"code":"1000","description":"Approved"},"paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","status":"AUTHORIZED","timestamp":"2022-01-30T10:10:10Z","reference":"example-customer-order-code","amount":1500,"currencyCode":"GBP","paymentInstrument":{"type":"card","nameOnCard":"John F Doe","pan":"1233 56## #### 1133","expiryDate":"06-30","fingerprint":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c6","fingerprintExtended":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c60630","cardMetadata":{"cardBrand":"VISA","issuer":"ACMEBANK","type":"DEBIT","category":"CLASSIC","countryIsoA2":"GB","commercial":true,"bin":"45678765"}},"psp":{"name":"Barclaycard Smartpay Fuse","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"}}},"authorized-with-psp-token-payment-instrument":{"summary":"Authorized payment using a pspToken","description":"A successful payment using a PSP Token as the payment instrument will return the PSP token which was used to create the payment as part of the payment response.\n","value":{"code":"1000","message":"Approved","comcardeCode":{"code":"1000","description":"Approved"},"paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","status":"AUTHORIZED","timestamp":"2022-01-30T10:10:10Z","reference":"example-customer-order-code","amount":1500,"currencyCode":"GBP","paymentInstrument":{"type":"pspToken","token":"ABC123"},"psp":{"name":"Checkout.com","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"}}},"Payment status with risk assessment information":{"summary":"Payment status with RiskAssessment field included","description":"The riskAssessments field contains information about the outcome of risk assessments performed by risk engines\n","value":{"code":"1000","message":"Approved","comcardeCode":{"code":"1000","description":"Approved"},"paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","status":"AUTHORIZED","timestamp":"2022-01-30T10:10:10Z","reference":"example-customer-order-code","amount":1500,"currencyCode":"GBP","paymentInstrument":{"type":"card","nameOnCard":"John F Doe","pan":"1233 56## #### 1133","expiryDate":"06-30","cardMetadata":{"cardBrand":"VISA","issuer":"ACMEBANK","type":"DEBIT","category":"CLASSIC","countryIsoA2":"GB","commercial":true,"bin":"45678765"}},"psp":{"name":"Barclaycard Smartpay Fuse","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"},"riskAssessments":{"kount":{"score":90.1,"decision":"APPROVED","transactionId":"KJX50N55NGJS","tags":["SUBSCRIPTION","KNOWN_LOCATION"]}}}},"Payment status with payment instrument account information":{"summary":"Payment status with account field in payment instrument","description":"Account model contains information about the account on PSP side used for the payment.\n","value":{"code":"1000","message":"Approved","comcardeCode":{"code":"1000","description":"Approved"},"paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","status":"AUTHORIZED","timestamp":"2022-01-30T10:10:10Z","reference":"example-customer-order-code","amount":1500,"currencyCode":"GBP","paymentInstrument":{"type":"trustly","account":{"accountId":"1234567890","bank":"Barclays","town":"PaloAlto","name":"John Mockington","address":"LincolnDrive","postcode":"456","descriptor":"**926819","lastDigits":"926819","clearingHouse":"UNITED_KINGDOM","verified":true}},"psp":{"name":"Trustly","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"}}},"captured":{"summary":"Captured Payment","description":"If BR-DGE receives a PSP notification that one of your transactions has been updated to captured status then this information will be passed on to you via a BR-DGE callback.\n","value":{"code":"1000","message":"Approved","comcardeCode":{"code":"1000","description":"Approved"},"paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","status":"CAPTURED","timestamp":"2022-01-30T10:10:10Z","reference":"example-customer-order-code","amount":1500,"currencyCode":"GBP","paymentInstrument":{"type":"applePay"},"psp":{"name":"Barclaycard Smartpay Fuse","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"}}},"voided":{"summary":"Voided Payment","description":"If BR-DGE receives a PSP notification that one of your transactions has been updated to void status then this information will be passed on to you via a BR-DGE callback.\n","value":{"code":"1000","message":"Approved","comcardeCode":{"code":"1000","description":"Approved"},"paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","status":"VOIDED","timestamp":"2022-01-30T10:10:10Z","reference":"example-customer-order-code","amount":1500,"currencyCode":"GBP","paymentInstrument":{"type":"payPal"},"psp":{"name":"Trust Payments","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"}}},"void-error":{"summary":"Error with void request","description":"If BR-DGE receives a PSP notification of an error with your transaction.\n","value":{"code":"4252","message":"Transaction Error: Maximum number of attempts to process request reached","comcardeCode":{"code":"4252","description":"Transaction Error: Maximum number of attempts to process request reached"},"paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","status":"AUTHORIZED","timestamp":"2022-01-30T10:10:10Z","reference":"example-customer-order-code","amount":1500,"currencyCode":"GBP","paymentInstrument":{"type":"ideal"},"psp":{"name":"Checkout.com","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"}}},"declined":{"summary":"Declined Payment","description":"A transaction has been submitted for Authorization to the Processor and this request has been processed and declined. The transaction could have either been declined by the Processor, due to rules within their system [Fraud, velocity limits, value limits], or by the Card Issuer. There will be an associated `reason` assigned to this state providing details of the decline.\n","value":{"code":"4201","message":"Transaction Error: Transaction declined by payment processor - customer will need to contact their bank for more details","comcardeCode":{"code":"4201","description":"Transaction Error: Transaction declined by payment processor - customer will need to contact their bank for more details"},"paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","status":"AUTHORIZATION_DECLINED","timestamp":"2022-01-30T10:10:10Z","reference":"example-customer-order-code","amount":1500,"currencyCode":"GBP","paymentInstrument":{"type":"bancontact"},"psp":{"name":"Barclaycard Smartpay Fuse","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"}}},"rejected":{"summary":"Rejected Payment","description":"A transaction has been submitted for Authorization to the processor and this been rejected due to a validation or a technical error. This rejection could have occurred either within the BR-DGE platform, the Processor or the Card Issuer. There will be an associated `reason` assigned to this state providing details of the rejection.\n","value":{"code":"4251","message":"Transaction Error: Payment was rejected by payment processor","comcardeCode":{"code":"4251","description":"Transaction Error: Payment was rejected by payment processor"},"paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","status":"REJECTED","timestamp":"2022-01-30T10:10:10Z","reference":"example-customer-order-code","amount":1500,"currencyCode":"GBP","paymentInstrument":{"type":"card","nameOnCard":"John F Doe","pan":"1233 56## #### 1133","expiryDate":"06-30","fingerprint":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c6","fingerprintExtended":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c60630","cardMetadata":{"cardBrand":"VISA","issuer":"ACMEBANK","type":"DEBIT","category":"CLASSIC","countryIsoA2":"GB","commercial":true,"bin":"45678765"}},"psp":{"name":"Barclaycard Smartpay Fuse","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"}}},"capture-or-void-error":{"summary":"Error capturing or voiding an authorized payment","description":"If your transaction was authorized but there was an issue capturing or voiding the transaction.\n","value":{"code":"4252","message":"Transaction Error: Maximum number of attempts to process request reached","comcardeCode":{"code":"4252","description":"Transaction Error: Maximum number of attempts to process request reached"},"paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","status":"AUTHORIZED","timestamp":"2022-01-30T10:10:10Z","reference":"example-customer-order-code","amount":1500,"currencyCode":"GBP","paymentInstrument":{"type":"card","nameOnCard":"John F Doe","pan":"1233 56## #### 1133","expiryDate":"06-30","fingerprint":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c6","fingerprintExtended":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c60630","cardMetadata":{"cardBrand":"VISA","issuer":"ACMEBANK","type":"DEBIT","category":"CLASSIC","countryIsoA2":"GB","commercial":true,"bin":"45678765"}},"psp":{"name":"Checkout.com","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"}}},"Card payment instrument not found":{"value":{"code":"1000","message":"Approved","comcardeCode":{"code":"1000","description":"Approved"},"paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","status":"CAPTURED","timestamp":"2022-01-30T10:10:10Z","reference":"example-customer-order-code","amount":1500,"currencyCode":"GBP","paymentInstrument":{"type":"card"},"psp":{"name":"Checkout.com","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"}},"description":"This example occurs when the payment status is returned but the card payment instrument details are unavailable.\n\nThe retrieval of payment instrument details will only be attempted for card payments.\n"},"Payment Status with included issuerResponse":{"summary":"Payment with included issuerResponse","description":"If the parameters ?include=issueResponse are used and the payment has an issuerResponse. IssuerResponses are only captured from Fat Zebra and WorldPay (WPG)\n","value":{"code":"1000","message":"Approved","comcardeCode":{"code":"1000","description":"Approved"},"paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","included":[{"id":"ISSUER_1","type":"issuerResponse","attributes":{"type":"issuerResponse","issuerResponse":{"issuerPaymentMethod":"MasterCard","issuerCardType":"Debit"}}}],"relationships":{"issuerResponse":{"data":{"type":"issuerResponse","id":"ISSUER_1"}}},"psp":{"name":"Fat Zebra","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"}}},"With cashier Id":{"summary":"Payment made using the Cashier","description":"A transaction submitted through the Cashier will include a cashierId field in the response.\n","value":{"code":"1000","message":"Approved","comcardeCode":{"code":"1000","description":"Approved"},"paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","status":"CAPTURED","timestamp":"2022-01-30T10:10:10Z","reference":"example-customer-order-code","paymentInstrument":{"type":"paysafecard"},"cashierId":"43ee1f43-df8b-47df-9b7d-33e3f69879b1"}},"payment-status-with-custom-metadata":{"summary":"Payment with custom metadata","value":{"code":"1000","message":"Approved","comcardeCode":{"code":"1000","description":"Approved"},"paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","status":"AUTHORIZED","timestamp":"2022-01-30T10:10:10Z","reference":"example-customer-order-code","amount":1500,"currencyCode":"GBP","paymentInstrument":{"type":"card","nameOnCard":"John F Doe","pan":"1233 56## #### 1133","expiryDate":"06-30","fingerprint":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c6","fingerprintExtended":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c60630","cardMetadata":{"cardBrand":"VISA","issuer":"ACMEBANK","type":"DEBIT","category":"CLASSIC","countryIsoA2":"GB","commercial":true,"bin":"45678765"}},"psp":{"name":"Barclaycard Smartpay Fuse","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"},"customMetadata":{"accountAge":"2","transactionType":"Other"}}},"payment-blocked":{"summary":"Payment Blocked","description":"A payment blocked due to routing rules, the blocking rule is provided in the response.\n","value":{"paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","merchantTransactionId":"65748db8-c794-4bcc-a886-8547e12fe052","code":"4805","message":"Blocked by Routing Rules","timestamp":"2022-01-30T10:10:10Z","paymentInstrument":{"type":"card","nameOnCard":"John F Doe","pan":"1233-56##-####-1133","expiryDate":"06-30","cardMetadata":{"cardBrand":"VISA","issuer":"ACMEBANK","type":"PREPAID","category":"CLASSIC","countryIsoA2":"GB","commercial":true,"bin":"45678765"},"fingerprint":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c6","fingerprintExtended":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c60630"},"status":"BLOCKED","reference":"example-customer-order-code","comcardeCode":{"code":"4805","description":"Blocked by Routing Rules"},"customMetadata":{},"amount":1500,"currencyCode":"GBP","blockingRule":{"name":"Block pre-paid cards"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/UnauthorizedRequest"},"404":{"$ref":"#/components/responses/EntityNotFound"},"500":{"$ref":"#/components/responses/UnknownServerError"}}}},"/paypal/orders":{"post":{"tags":["PayPal"],"summary":"Create a PayPal Order","operationId":"createPayPalOrderUsingPOST","security":[{"ServerApiKey":[]}],"requestBody":{"required":true,"description":"The information provided here will be used to create a new order with PayPal.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayPalOrderRequest"},"examples":{"Full Create PayPal Order Request":{"description":"This example shows all potential fields used to create a PayPal order.\n","value":{"amount":1010,"currencyCode":"GBP","intent":"capture","customerOrderCode":"ABC123","displayName":"Brand Name","locale":"en-GB","invoiceId":"987654321","enableShippingAddress":true,"shippingAddressEditable":false,"shippingAddressOverride":{"address1":"Victoria House","address2":"15 Apple Street","town":"Edinburgh","county":"Lothian","postcode":"BH23 6AA","country":"GB","phoneNumber":"+44 123 1110000","recipientName":"John Smith","buildingNumberOrName":"Flat 1"},"lineItems":[{"name":"T-Shirt","description":"BR-DGE T-Shirt","quantity":1,"unitAmount":1000,"unitTax":10}],"customer":{"accountId":"123456789","firstName":"John","lastName":"Smith","email":"a@b.com","phoneNumber":"+44 123 1110000","country":"GB","creationTimestamp":"2012-12-09T19:14:55.277-0:00"},"ota":{"type":"bus","serviceStartDate":"2012-12-09T19:14:55.277-0:00","serviceEndDate":"2012-12-09T19:14:55.277-0:00","changeGuest":false,"startCountry":"GB","startCity":"Edinburgh","startPostcode":"BH23 6AA"},"customerIpAddress":"123.100.100.200","customerId":"8540b512-ef98-4ded-b6ff-53e78c3a3568"}}}}}},"responses":{"201":{"description":"Order created. You can now redirect your customer to the provided URL.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayPalOrderResponse"},"example":{"id":"4fad8e2e06a15656","code":"1000","message":"Order Created","orderId":"5O190127TN364715T","redirectUrl":"http://www.return.url","intent":"authorize","status":"CREATED","creationTimestamp":"2024-05-07T18:46:54Z"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/UnauthorizedRequest"},"500":{"$ref":"#/components/responses/UnknownServerError"}}}},"/paypal/orders/{orderId}":{"get":{"tags":["PayPal"],"summary":"Get the details of a PayPal Order.","operationId":"getPayPalOrderDetailsUsingGET","security":[{"ServerApiKey":[]}],"parameters":[{"$ref":"#/components/parameters/pathOrderId"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayPalOrder"},"examples":{"Successfully get PayPal order":{"description":"Successfully return PayPal order details.\n","value":{"orderId":"5O190127TN364715T","intent":"capture","status":"APPROVED","creationTimestamp":"2024-05-07T18:46:54Z","paymentSource":{"name":"John Smith","email":"test@email.com","accountId":"QYR5Z8XDVJNXQ"},"purchaseUnits":[{"referenceId":"d9f80740-38f0-11e8-b467-0ed5f89f718b","description":"T-Shirt","customId":"123456789","invoiceId":"987654321","unitAmount":100,"unitTax":10,"currencyCode":"GBP"}]}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/UnauthorizedRequest"},"500":{"$ref":"#/components/responses/UnknownServerError"}}}},"/paypal/orders/{orderId}/payments":{"post":{"tags":["PayPal"],"summary":"Authorize or Capture a payment for a PayPal Order.","operationId":"payPalOrderPaymentUsingPOST","security":[{"ServerApiKey":[]}],"parameters":[{"$ref":"#/components/parameters/pathOrderId"}],"requestBody":{"required":true,"description":"The information provided here will be used to complete a payment for a given PayPal Order.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayPalOrderPaymentRequest"},"examples":{"Authorize payment for PayPal Order":{"description":"Example authorize only PayPal payment.\n","value":{"intent":"authorize"}},"Capture payment for PayPal Order":{"description":"Example capture only PayPal payment.\n","value":{"intent":"capture"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayPalOrderPaymentResponse"},"examples":{"Capture payment for PayPal order":{"description":"Successfully capture payment for PayPal order.\n","value":{"id":"4fad8e2e06a15656","code":"1000","message":"Approved","paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","orderId":"5O190127TN364715T","status":"CAPTURED","amount":100}},"Authorize payment for PayPal order":{"description":"Successfully authorize payment for PayPal order.\n","value":{"id":"4fad8e2e06a15656","code":"1000","message":"Approved","paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","orderId":"5O190127TN364715T","status":"AUTHORIZE","amount":100}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/UnauthorizedRequest"},"500":{"$ref":"#/components/responses/UnknownServerError"}}}},"/orders":{"post":{"tags":["Orders"],"summary":"Create a BR-DGE Hosted Payment Page Order","operationId":"createOrderUsingPOST","security":[{"ServerApiKey":[]}],"requestBody":{"required":true,"description":"The information provided here will be combined with payment instrument data collected from shoppers via a BR-DGE Hosted Payment Page for use in payments.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"},"examples":{"Simple Order Details":{"description":"This example shows the minimum fields required to create an order\n","value":{"amount":1000,"currencyCode":"GBP","customerEmail":"a@b.com","customerFirstName":"John","customerOrderCode":"ABC123","orderDescription":"Taxi fare","returnUrl":"http://www.return.url"}},"Full Order with surcharge rule":{"description":"This example shows all the fields you can specify for an order. Most of the details will be directly mapped into any payment requests associated with the order.\n\nPlease note: The billing address used in payment requests may vary depending on the payment method chosen by shoppers.\n","value":{"amount":1000,"billingAddress":{"firstName":"John","lastName":"Smith","buildingNumberOrName":"10a","address1":"Flat 1","address2":"Victoria House","address3":"15 Apple Street","town":"Edinburgh","county":"Lothian","postcode":"BH23 6AA","country":"GB","phoneNumber":"+44 123 1110000"},"corporateCardPercentageSurcharge":12.5,"currencyCode":"GBP","customerEmail":"a@b.com","customerFirstName":"John","customerLastName":"Smith","customerOrderCode":"ABC123","customerPhoneNumber":"+44 123 1110000","deliveryAddress":{"firstName":"John","lastName":"Smith","buildingNumberOrName":"10a","address1":"Flat 1","address2":"Victoria House","address3":"15 Apple Street","town":"Edinburgh","county":"Lothian","postcode":"BH23 6AA","country":"GB","phoneNumber":"+44 123 1110000"},"orderDescription":"Taxi fare","returnUrl":"http://www.return.url","threeDSecureOptions":{"challengeRequested":false,"exemptionRequested":false},"threeDSecureRequired":true}},"Split Auth and Capture":{"description":"By default payments associated with orders are are captured immediately, but by setting intent to authorize you can control when payments are captured or voided using the `/payments/{paymentId}/capture` and `/payments/{paymentId}/void` endpoints. Payment identifiers will be provided when you query the status of an order via `/orders/{orderId}/status`.\n","value":{"intent":"authorize","amount":1000,"currencyCode":"GBP","customerEmail":"a@b.com","customerFirstName":"John","customerOrderCode":"ABC123","orderDescription":"Taxi fare","returnUrl":"http://www.return.url"}},"Offer to save card Details":{"description":"If you want to give you customer the option to save their card details then you can configure orders with a link to your terms and conditions, and the payment page will display a checkbox for saving the card.\n","value":{"amount":1000,"cardOnFileTermsAndConditionsUrl":"https://url/to-terms","currencyCode":"GBP","customerEmail":"a@b.com","customerFirstName":"John","customerOrderCode":"ABC123","orderDescription":"Taxi fare","returnUrl":"http://www.return.url"}},"Customer agreed to save card":{"description":"You can indicate whether consent to save card has been gained prior to creating an order using the `customerAgreedToSaveCard` field. The Hosted Payment Page will then automatically save any card details that are entered.\n","value":{"amount":1000,"cardOnFileTermsAndConditionsUrl":"https://url/to-terms","currencyCode":"GBP","customerAgreedToSaveCard":true,"customerEmail":"a@b.com","customerFirstName":"John","customerOrderCode":"ABC123","orderDescription":"Taxi fare","returnUrl":"http://www.return.url"}},"Offering a set of existing Cards on File as payment methods":{"description":"If there are existing Cards on File that you wish to offer as payment methods then you can provide a set of comma-delimited multi-use tokens for those Cards on File.\n","value":{"amount":1000,"currencyCode":"GBP","customerEmail":"a@b.com","customerFirstName":"John","customerOrderCode":"ABC123","orderDescription":"Taxi fare","returnUrl":"http://www.return.url","tokens":"8d9f37a0-d8de-4ca2-beb0-7f14ae73f02c,9777eec0-d497-4246-bad1-ac8a8058ff2b,be8b7808-6cb7-4c08-aaa9-d9b77d6cb7e8"}},"Associate order with Customer Identifier":{"description":"You can optionally associate an order with a customer identifier via the `customerId` field. This will result in any pre-existing Cards on File associated with the identifier being offered as payment methods. Any new Cards on File created for the order will also be associated with the customer.\n","value":{"amount":1000,"cardOnFileTermsAndConditionsUrl":"https://url/to-terms","currencyCode":"GBP","customerEmail":"a@b.com","customerFirstName":"John","customerId":"123","customerOrderCode":"ABC123","orderDescription":"Taxi fare","returnUrl":"http://www.return.url"}},"Initial payment for an MIT agreement and create new Card-on-File":{"description":"This example shows the Hosted Payment Page being used to create a Card on File and perform an initial transaction for an MIT agreement. For more information please see [here](https://docs.br-dge.io/docs/vault#making-merchant-initiated-transactions-mits-using-card-on-file).","value":{"merchantInitiated":"unscheduled","allowedPaymentInstruments":["card"],"customerAgreedToSaveCard":true,"cardOnFileTermsAndConditionsUrl":"https://url/to-MIT-agreement-terms","threeDSecureRequired":true,"amount":1000,"currencyCode":"GBP","customerEmail":"a@b.com","customerFirstName":"John","customerOrderCode":"ABC123","orderDescription":"Taxi fare","returnUrl":"http://www.return.url"}},"Initial payment for an MIT agreement with an existing Card-on-File":{"description":"This example shows the Hosted Payment Page being used to perform an initial transaction for an MIT agreement with an existing BR-DGE Card on File. For more information please see [here](https://docs.br-dge.io/docs/vault#making-merchant-initiated-transactions-mits-using-card-on-file).","value":{"merchantInitiated":"unscheduled","allowedPaymentInstruments":["card"],"tokens":"da000a2c-da85-4aed-843e-679dd6c7376f","threeDSecureRequired":true,"amount":1000,"currencyCode":"GBP","customerEmail":"a@b.com","customerFirstName":"John","customerOrderCode":"ABC123","orderDescription":"Taxi fare","returnUrl":"http://www.return.url"}},"Limit Payment Methods to only offer Apple Pay and Google Pay":{"description":"This example shows how its possible to customize the available payment methods on a per-order basis (in this case to only offer Google Pay and Apple Pay) by specifying a set of allowed payment methods when creating an order.\n\nThis will result in any payment methods not in the set not being offered for that order.\n","value":{"allowedPaymentInstruments":["googlePay","applePay"],"amount":1000,"currencyCode":"GBP","customerEmail":"a@b.com","customerFirstName":"John","customerOrderCode":"ABC123","orderDescription":"Taxi fare","returnUrl":"http://www.return.url"}},"Limit Payment Methods to only offer Cards and Visa Instalments":{"description":"This example shows that when customizing allowed payment methods for an order to include Visa Instalments you must also enable cards.\n\nPlease note that it is still possible to enable other payment methods alongside cards and Visa Instalments.\n","value":{"allowedPaymentInstruments":["card","visaInstalments"],"amount":1000,"currencyCode":"GBP","customerEmail":"customer@example.org","customerFirstName":"John","customerOrderCode":"VIS-1234567","orderDescription":"Order with Visa Instalments enabled","returnUrl":"http://www.return.url"}}}}}},"responses":{"201":{"description":"Order created. You can now redirect your customer to the provided URL.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderResponse"},"example":{"code":"1000","id":"4fad8e2e06a15656","message":"Order created","orderId":"6c85d805-25e6-498d-b1d2-97d3c85a9095","redirectUrl":"https://sandbox.comcarde.com/order/6c85d805-25e6-498d-b1d2-97d3c85a9095/"}}},"links":{"Get status of an Order":{"operationId":"getOrderStatusUsingGET","parameters":{"orderId":"$response.body#/orderId"},"description":"One your customer is redirected back to you after interacting with the BR-DGE Hosted Payment Page then you can confirm the outcome of any payments using the `orderId` returned in the response as the `paymentId` parameter in `GET /orders/{orderId}/status`.\n"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/UnauthorizedRequest"},"500":{"$ref":"#/components/responses/UnknownServerError"}},"callbacks":{"Payment Status Change Events":{"https://example.com/BR-DGE/ as defined in your retail channel config":{"post":{"operationId":"callbackOrderStatusChangeEvents","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentStatusChangeEvent"},"examples":{"authorization-pending":{"$ref":"#/components/examples/authorization-pending"},"capture-pending":{"$ref":"#/components/examples/capture-pending"},"captured":{"$ref":"#/components/examples/captured"},"declined":{"$ref":"#/components/examples/declined"},"rejected":{"$ref":"#/components/examples/rejected"},"capture-failed":{"$ref":"#/components/examples/capture-failed"}}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"PSP Token Status Change Event":{"$ref":"#/components/callbacks/PspTokenStatusChangeEvent"},"PSP Token Provisioning Failed Event":{"$ref":"#/components/callbacks/PspTokenProvisioningFailedEvent"},"Network Token Provisioning Failed Event":{"$ref":"#/components/callbacks/NetworkTokenProvisioningFailedEvent"},"Network Token Status Change Event":{"$ref":"#/components/callbacks/NetworkTokenStatusChangeEvent"},"Network Token Metadata Update Event":{"$ref":"#/components/callbacks/NetworkTokenMetadataUpdateEvent"}}}},"/orders/{orderId}/cancel":{"put":{"tags":["Orders"],"summary":"Cancel a previously created BR-DGE Hosted Payment Page Order.","operationId":"cancelOrderUsingPUT","security":[{"ServerApiKey":[]}],"parameters":[{"$ref":"#/components/parameters/pathOrderId"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderResponse"},"examples":{"Order cancelled":{"description":"Order has been cancelled, and no further payment attempts can be made\n","value":{"code":"1009","message":"Order cancelled - no future actions possible with this order"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedRequest"},"403":{"description":"Forbidden request"},"404":{"$ref":"#/components/responses/EntityNotFound"}}}},"/orders/{orderId}/status":{"get":{"tags":["Orders"],"summary":"Get the status of a BR-DGE Hosted Payment Page Order.","operationId":"getOrderStatusUsingGET","security":[{"ServerApiKey":[]}],"parameters":[{"$ref":"#/components/parameters/pathOrderId"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderStatusResponse"},"examples":{"Successful first payment attempt":{"description":"Best case scenario. The first payment attempt is successful and full card metadata is returned.\n","value":{"code":"1006","message":"Order completed","creationTimestamp":"2022-01-30T10:10:10Z","payments":[{"paymentId":"db805559-7cc4-4866-9e52-0b60fa59f12b","code":"1000","message":"Approved","timestamp":"2022-01-30T10:10:10Z","paymentInstrument":{"type":"card","nameOnCard":"John F Doe","pan":"1233 56## #### 1133","expiryDate":"06-30","cardMetadata":{"cardBrand":"VISA","issuer":"ACMEBANK","type":"DEBIT","category":"CLASSIC","countryIsoA2":"GB","commercial":true}},"psp":{"name":"Worldline Online Payments","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"}}]}},"Successful second payment attempt":{"description":"This first payment attempt failed, but the shopper tried again successfully with the same card. This response also demonstrates what happens when some card metadata is missing.\n","value":{"code":"1006","message":"Order completed","creationTimestamp":"2022-01-30T10:10:10Z","payments":[{"paymentId":"db805559-7cc4-4866-9e52-0b60fa59f12b","code":"1000","message":"Approved","timestamp":"2022-01-30T10:10:10Z","paymentInstrument":{"type":"card","nameOnCard":"John F Doe","pan":"1233 56## #### 1133","expiryDate":"06-30","cardMetadata":{"cardBrand":"VISA","type":"DEBIT","countryIsoA2":"GB","commercial":true}},"psp":{"name":"Braintree","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"}},{"paymentId":"5317d6ec-9a08-41d7-bf1a-aa605ae89690","code":"4203","message":"Withdrawal limit exceeded","timestamp":"2022-01-30T10:08:10Z","paymentInstrument":{"type":"card","nameOnCard":"John F Doe","pan":"1233 56## #### 1133","expiryDate":"06-30","cardMetadata":{"cardBrand":"VISA","type":"DEBIT","countryIsoA2":"GB","commercial":true}},"psp":{"name":"Nuvei","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"}}]}},"Successful third payment attempt":{"description":"This example shows the third and last payment attempt being successful. The shopper using different cards each time.\n\nNote that the second attempt demonstrates that you will receive if we are unable to find metadata for the card used.\n","value":{"code":"1006","message":"Order completed","creationTimestamp":"2022-01-30T10:10:10Z","payments":[{"paymentId":"db805559-7cc4-4866-9e52-0b60fa59f12b","code":"1000","message":"Approved","timestamp":"2022-01-30T10:10:10Z","paymentInstrument":{"type":"card","nameOnCard":"John F Doe","pan":"1233 56## #### 1133","expiryDate":"06-30","cardMetadata":{"cardBrand":"VISA","issuer":"ACMEBANK","type":"DEBIT","category":"CLASSIC","countryIsoA2":"GB","commercial":true}},"psp":{"name":"Trust Payments","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"}},{"paymentId":"15446bcf-19bb-4186-9b50-81a72d635275","code":"4203","message":"Withdrawal limit exceeded","timestamp":"2022-01-30T10:08:10Z","paymentInstrument":{"type":"card","nameOnCard":"John F Doe","pan":"1233 56## #### 0000","expiryDate":"06-30"},"psp":{"name":"Worldline Online Payments","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"}},{"paymentId":"b8040023-0848-4d32-a0bc-1c29fd021ee5","code":"4203","message":"Withdrawal limit exceeded","timestamp":"2022-01-30T10:07:10Z","paymentInstrument":{"type":"card","nameOnCard":"John F Doe","pan":"1233 56## #### 555","expiryDate":"06-30","cardMetadata":{"cardBrand":"MASTERCARD"}},"psp":{"name":"Stripe","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"}}]}},"Three failed payment attempts":{"description":"Shoppers will get up to three payments attempts per order, after which they are automatically redirected back to the merchant.\n","value":{"code":"1008","message":"Order lapsed","creationTimestamp":"2022-01-30T10:09:10Z","payments":[{"paymentId":"fc2a896a-70d5-4c37-b9bc-ef2270400c92","code":"4203","message":"Withdrawal limit exceeded","timestamp":"2022-01-30T10:09:10Z","paymentInstrument":{"type":"card","nameOnCard":"John F Doe","pan":"1233 56## #### 1133","expiryDate":"06-30","cardMetadata":{"cardBrand":"VISA","issuer":"ACMEBANK","type":"DEBIT","category":"CLASSIC","countryIsoA2":"GB","commercial":true}},"psp":{"name":"Braintree","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"}},{"paymentId":"15446bcf-19bb-4186-9b50-81a72d635275","code":"4203","message":"Withdrawal limit exceeded","timestamp":"2022-01-30T10:08:10Z","paymentInstrument":{"type":"card","nameOnCard":"John F Doe","pan":"1233 56## #### 1133","expiryDate":"06-30","cardMetadata":{"cardBrand":"VISA","issuer":"ACMEBANK","type":"DEBIT","category":"CLASSIC","countryIsoA2":"GB","commercial":true}},"psp":{"name":"Barclaycard ePDQ - Smartpay Checkout","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"}},{"paymentId":"b8040023-0848-4d32-a0bc-1c29fd021ee5","code":"4203","message":"Withdrawal limit exceeded","timestamp":"2022-01-30T10:07:10Z","paymentInstrument":{"type":"card","nameOnCard":"John F Doe","pan":"1233 56## #### 1133","expiryDate":"06-30","cardMetadata":{"cardBrand":"VISA","issuer":"ACMEBANK","type":"DEBIT","category":"CLASSIC","countryIsoA2":"GB","commercial":true}},"psp":{"name":"Barclaycard Smartpay Fuse","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"}}]}},"Card on File created":{"description":"If a new BR-DGE Card on File was created when processing the order then its multi-use token is returned via `cardOnFileTokenCreated`.\n","value":{"cardOnFileTokenCreated":"12ac7fb1-f2b0-47bd-bf8b-d4853ad45851","code":"1006","message":"Order completed","creationTimestamp":"2022-01-30T10:10:10Z","payments":[{"paymentId":"db805559-7cc4-4866-9e52-0b60fa59f12b","code":"1000","message":"Approved","timestamp":"2022-01-30T10:10:10Z","paymentInstrument":{"type":"card","nameOnCard":"John F Doe","pan":"1233 56## #### 1133","expiryDate":"06-30","cardMetadata":{"cardBrand":"VISA","issuer":"ACMEBANK","type":"DEBIT","category":"CLASSIC","countryIsoA2":"GB","commercial":true}},"psp":{"name":"Worldline Online Payments","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"}}]}},"ApplePay":{"description":"If Apple Pay is used as a payment instrument then the `payments[].paymentInstrument.type` will be set to `applePay`.\n","value":{"code":"1006","message":"Order completed","creationTimestamp":"2022-01-30T10:10:10Z","payments":[{"paymentId":"db805559-7cc4-4866-9e52-0b60fa59f12b","code":"1000","message":"Approved","timestamp":"2022-01-30T10:10:10Z","paymentInstrument":{"type":"applePay"},"psp":{"name":"Cybersource","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"}}]}},"GooglePay":{"description":"If Google Pay is used as a payment instrument then the `payments[].paymentInstrument.type` will be set to `googlePay`.\n","value":{"code":"1006","message":"Order completed","creationTimestamp":"2022-01-30T10:10:10Z","payments":[{"paymentId":"db805559-7cc4-4866-9e52-0b60fa59f12b","code":"1000","message":"Approved","timestamp":"2022-01-30T10:10:10Z","paymentInstrument":{"type":"googlePay"},"psp":{"name":"Nuvei","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"}}]}},"PayPal":{"description":"If PayPal is used as a payment instrument then the `payments[].paymentInstrument.type` will be set to `payPal`.\n","value":{"code":"1006","message":"Order completed","creationTimestamp":"2022-01-30T10:10:10Z","payments":[{"paymentId":"db805559-7cc4-4866-9e52-0b60fa59f12b","code":"1000","message":"Approved","timestamp":"2022-01-30T10:10:10Z","paymentInstrument":{"type":"payPal"},"psp":{"name":"Cybersource","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"}}]}},"Order newly created":{"description":"Order is newly created\n","value":{"code":"1005","message":"Order created","creationTimestamp":"2022-01-30T10:10:10Z"}},"Order cancelled":{"description":"Order has been cancelled, and no further payment attempts can be made\n","value":{"code":"1009","message":"Order cancelled - no future actions possible with this order","creationTimestamp":"2022-01-30T10:10:10Z","lastUpdatedTimestamp":"2022-01-30T12:05:10Z"}}}}},"links":{"Refund a Payment":{"operationId":"createRefundUsingPOST","parameters":{"paymentId":"$response.body#/payments[x]/paymentId"},"description":"The `paymentId` value for successful payments can be used as the `paymentId` parameter in `POST /payments/{paymentId}/refund`.\n"}}},"401":{"$ref":"#/components/responses/UnauthorizedRequest"},"404":{"$ref":"#/components/responses/EntityNotFound"},"500":{"$ref":"#/components/responses/UnknownServerError"}}}},"/payouts":{"post":{"tags":["Payouts"],"summary":"Create a payout","description":"Send money to your customers.\n","operationId":"createPayoutUsingPOST","security":[{"ServerApiKey":[]}],"requestBody":{"required":true,"description":"Details of the payout to be initiated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutRequest"},"examples":{"card-on-File":{"summary":"Payout to Card-on-File","description":"Example payout to a pre-existing Card-on-File\n","value":{"psp":"Checkout.com","amount":1000,"currencyCode":"GBP","recipient":{"firstName":"John","ipAddress":"123.100.100.200","lastName":"Smith"},"paymentInstrument":{"type":"tokenized","token":"90289ce4-e0eb-48ca-8f8c-d2793eef387e"},"reference":"abc123","purpose":"leisure"}},"ApplePay":{"summary":"Payout to Apple Pay","description":"You can make a payout to Apple Pay by referencing a previous pay-in payment using Apple Pay.\n","value":{"psp":"Checkout.com","amount":1000,"currencyCode":"GBP","recipient":{"firstName":"John","ipAddress":"123.100.100.200","lastName":"Smith"},"paymentInstrument":{"type":"payInReference","paymentId":"cff9dc83-f89c-4bfe-bb2b-20000d6251d6"},"reference":"abc123","purpose":"leisure"}},"EasyPayPayout":{"summary":"Payout to a Nuvei Account using EasyPay","description":"Make a payout to an Easypay Account.\n","value":{"psp":"Nuvei","amount":1000,"currencyCode":"GBP","recipient":{"firstName":"John","ipAddress":"123.100.100.200","lastName":"Smith","customerId":"CUSTOMER123","dateOfBirth":"2001-01-20"},"paymentInstrument":{"type":"easyPay","customerId":"123456","customerPaymentOptionId":"123456","easyPayEmail":"john.smtih@example.com","easyPayName":"john.smith","easyPayPersonalId":"123456","easyPayIdentificationDate":"2024-01-23","easyPayIdentificationNumber":"123456","easyPayIdentificationType":"4"},"reference":"abc123","purpose":"leisure"}},"EPayPayout":{"summary":"Payout to a Nuvei Account using ePay.bg","description":"Make a payout to an ePay.bg Nuvei Account.\n","value":{"psp":"Nuvei","amount":1000,"currencyCode":"GBP","recipient":{"firstName":"John","ipAddress":"123.100.100.200","lastName":"Smith","customerId":"CUSTOMER123","dateOfBirth":"2001-01-20"},"paymentInstrument":{"type":"ePay","customerId":"123456"},"reference":"abc123","purpose":"leisure"}},"GooglePay":{"summary":"Payout to Google Pay","description":"You can make a payout to Google Pay by referencing a previous pay-in payment using Google Pay.\n","value":{"psp":"Checkout.com","amount":1000,"currencyCode":"GBP","recipient":{"firstName":"John","ipAddress":"123.100.100.200","lastName":"Smith"},"paymentInstrument":{"type":"payInReference","paymentId":"cff9dc83-f89c-4bfe-bb2b-20000d6251d6"},"reference":"abc123","purpose":"leisure"}},"PspToken":{"summary":"Payout to PSP token","description":"Tokens created with the PSP can be used to make a payout, this payment instrument does not support payout flows which require a card PAN. This includes, but is not limited to, VISA Installments and Kount\n","value":{"psp":"Checkout.com","amount":1000,"currencyCode":"GBP","recipient":{"firstName":"John","ipAddress":"123.100.100.200","lastName":"Smith"},"paymentInstrument":{"type":"pspToken","token":"ABC123","psp":"Checkout.com","customerId":"Customer Id"},"reference":"abc123","purpose":"leisure"}},"PspTokenCybersource":{"summary":"Payout to Cybersource PSP token","description":"Cybersource PSP token payout require additional information to specify which type of Cybersource token is provided.\n","value":{"psp":"Cybersource","amount":1000,"currencyCode":"GBP","recipient":{"firstName":"John","ipAddress":"123.100.100.200","lastName":"Smith"},"paymentInstrument":{"type":"pspToken","token":"ABC123","psp":"Cybersource","customerId":"Customer Id","tokenType":"customer"},"reference":"abc123","purpose":"leisure"}},"Trustly":{"summary":"Payout to a Trustly Account","description":"Make a payout to a Trustly Account.\n","value":{"psp":"Trustly","amount":1000,"currencyCode":"GBP","recipient":{"firstName":"John","ipAddress":"123.100.100.200","lastName":"Smith","customerId":"CUSTOMER123"},"paymentInstrument":{"type":"trustly","accountId":"12341231","successUrl":"https://success.io","errorUrl":"https://fail.io"},"reference":"abc123","purpose":"leisure"}},"AstroPayPayout":{"summary":"Payout to an AstroPay Account","description":"Make a payout to a AstroPay Account.\n","value":{"psp":"AstroPay","amount":1000,"currencyCode":"BRL","recipient":{"firstName":"John","lastName":"Smith","customerId":"CUSTOMER123","documentId":"ABC-123456","documentType":"DNI"},"paymentInstrument":{"type":"astroPay","userId":"Cz5au5ZBHnzn","phoneNumber":"558534326168","country":"BR"},"reference":"abc123","purpose":"leisure"}},"Paysafecard":{"summary":"Payout to Paysafecard","value":{"psp":"Paysafecard","amount":1000,"currencyCode":"GBP","customerId":"8540b512-ef98-4ded-b6ff-53e78c3a3568","recipient":{"firstName":"John","lastName":"Smith","email":"john.smith@example.com","dateOfBirth":"2000-01-01"},"paymentInstrument":{"type":"paysafecard","paysafecardCustomerId":"151743187547","submerchantId":"RCxD1234"},"reference":"abc123","purpose":"leisure"}},"CardPayout":{"summary":"Payout to a Card Payment Instrument","description":"Make a payout to a card payment instrument\n","value":{"psp":"Cybersource","amount":1000,"currencyCode":"GBP","recipient":{"firstName":"John","ipAddress":"123.100.100.200","lastName":"Smith"},"paymentInstrument":{"type":"card","nameOnCard":"John F Doe","pan":"4444 3333 2222 1111","expiryDate":"01-99"},"reference":"abc123","purpose":"leisure"}},"SkrillPayout":{"summary":"Payout to Skrill","description":"Make a payout to a Skrill Account.\n","value":{"psp":"Skrill","amount":1000,"currencyCode":"GBP","recipient":{"email":"john@smith@example.com"},"paymentInstrument":{"type":"skrill"},"reference":"abc123","purpose":"leisure"}},"NetellerPayout":{"summary":"Payout to a Neteller Account","description":"Make a payout to a Neteller Account. The recipient email must be the e-mail address of the Neteller customer.\n","value":{"psp":"Paysafe","amount":1000,"currencyCode":"GBP","recipient":{"firstName":"John","lastName":"Smith","email":"a@b.com"},"paymentInstrument":{"type":"neteller"},"reference":"abc123","purpose":"leisure"}},"OttPayout":{"summary":"Payout to OTT Account","description":"Make a payout to a OTT Account.\n","value":{"psp":"OTT","amount":1000,"currencyCode":"ZAR","recipient":{"firstName":"John","lastName":"Smith","documentType":"RSAID","documentId":"9103215388086","documentIssuer":"ZA","gender":"male","dateOfBirth":"2000-01-01","email":"john@smith@example.com","phoneNumber":"+27721234567"},"paymentInstrument":{"type":"ottPayout","providerName":"Bank EFT","bankDetails":{"bankDetailsFormat":"ZA","accountName":"John Smith","accountNumber":"1352184990","branchName":"Main branch","branchCode":"400040"}},"reference":"abc123","purpose":"leisure"}},"PayoutWithCustomMetadata":{"summary":"Payout with additional custom metadata","description":"Make a payout with custom metadata fields defined.\n","value":{"psp":"Paysafe","amount":1000,"currencyCode":"GBP","recipient":{"firstName":"John","lastName":"Smith","email":"a@b.com"},"paymentInstrument":{"type":"neteller"},"reference":"abc123","purpose":"leisure","customMetadata":{"accountAge":"2","transactionType":"Other"}}},"PayoutWithRecipientAddress":{"summary":"Payout with recipient address","description":"Make a payout with recipient address defined\n","value":{"psp":"Checkout.com","amount":1000,"currencyCode":"GBP","recipient":{"firstName":"John","ipAddress":"123.100.100.200","lastName":"Smith","dateOfBirth":"2001-01-20","address":{"buildingNumberOrName":"Flat 1","address1":"Victoria House","address2":"15 Apple Street","town":"Edinburgh","county":"Lothian","postcode":"BH23 6AA","country":"GB","countrySubdivisionCode":"EDH"}},"paymentInstrument":{"type":"card","nameOnCard":"John F Doe","pan":"4444 3333 2222 1111","expiryDate":"01-99"},"reference":"abc123","purpose":"leisure"}},"payout-request-true-layer-paymentsource":{"$ref":"#/components/examples/payout-request-true-layer-paymentsource"},"payout-request-true-layer-scan":{"$ref":"#/components/examples/payout-request-true-layer-scan"},"payout-request-true-layer-iban":{"$ref":"#/components/examples/payout-request-true-layer-iban"},"payout-request-true-layer-user-determined":{"$ref":"#/components/examples/payout-request-true-layer-user-determined"},"payout-request-worldpayAccessBankPayout-IBAN":{"$ref":"#/components/examples/payout-request-worldpayAccessBankPayout-IBAN"},"payout-request-worldpayAccessBankPayout-GB":{"$ref":"#/components/examples/payout-request-worldpayAccessBankPayout-GB"},"Bank2BankPayout":{"summary":"Payout to a bank account using Bank2Bank","value":{"psp":"WalletDoc","amount":1000,"currencyCode":"ZAR","recipient":{"firstName":"John","lastName":"Smith"},"paymentInstrument":{"type":"bank2bank","bankId":"TYME","accountNumber":"1234567890","accountName":"Savings Account 345","branchCode":"678910"},"reference":"abc123"}}}}}},"responses":{"201":{"description":"Payout request completed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutResponse"},"examples":{"Successful payout":{"value":{"code":"1000","message":"Approved","id":"4fad8e2e06a15656","paymentId":"22669f90-5bf0-45df-ba8c-ea6d4235a5da","payoutEligibility":{"crossBorderGambling":"FAST_FUNDS","crossBorderMoneyTransfer":"UNKNOWN","crossBorderNonMoneyTransfer":"NOT_SUPPORTED","domesticGambling":"STANDARD","domesticMoneyTransfer":"FAST_FUNDS","domesticNonMoneyTransfer":"UNKNOWN"},"psp":{"name":"Cybersource","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"},"paymentInstrument":{"type":"card"}}},"payout-response-true-layer":{"$ref":"#/components/examples/payout-response-true-layer"}}}}},"202":{"description":"The operation has been accepted for processing and the outcome is not yet known. Please refer to the webhook callbacks that are linked to this operation.\n","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PayoutResponse"},{"type":"object","properties":{"payoutEligibility":{"$ref":"#/components/schemas/PayoutEligibility"}}}]},"examples":{"Pending":{"value":{"code":"2101","message":"Pending - The operation has been accepted for processing and the outcome is not yet known. If an action is in the response, please see post-response actions, otherwise see callbacks.","id":"4fad8e2e06a15656","actionRequired":false,"payoutEligibility":{"crossBorderGambling":"FAST_FUNDS","crossBorderMoneyTransfer":"UNKNOWN","crossBorderNonMoneyTransfer":"NOT_SUPPORTED","domesticGambling":"STANDARD","domesticMoneyTransfer":"FAST_FUNDS","domesticNonMoneyTransfer":"UNKNOWN"},"psp":{"name":"Nuvei","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"},"paymentInstrument":{"type":"card"}}},"Pending - Further Action Required":{"value":{"code":"2101","message":"Pending - The operation has been accepted for processing and the outcome is not yet known. If an action is in the response, please see post-response actions, otherwise see callbacks.","id":"731Ahdfepal24","paymentId":"ca37-sv382v-28342f9","actionRequired":true,"action":{"type":"REDIRECT","paymentId":"14ecc3a1-4dd5-4941-838d-495ea4f405e2","data":{"redirectUrl":"https://br-dge.to/redirect"}},"psp":{"name":"Trustly","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4bc719f7c"},"paymentInstrument":{"type":"trustly"}}},"payout-response-true-layer-user-determined":{"$ref":"#/components/examples/payout-response-true-layer-user-determined"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/UnauthorizedRequest"},"409":{"description":"Indicates a request conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DuplicateMerchantTransactionIdError"},"examples":{"Duplicate merchantTransactionId provided":{"value":{"code":"4701","message":"Duplicate Merchant Transaction ID","id":"4fad8e2e06a15656","merchantTransactionId":"yourUniqueRequestId"}}}}}},"422":{"$ref":"#/components/responses/PayoutUnprocessableContentRequest"},"500":{"$ref":"#/components/responses/UnknownServerError"},"502":{"$ref":"#/components/responses/BadGatewayNetworkError"}},"callbacks":{"Payout Status Change Events":{"https://example.com/BR-DGE/ as defined in your retail channel config":{"post":{"operationId":"callbackPayoutStatusChangeEvents","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutStatusChangeEvent"},"examples":{"Pending":{"summary":"Payout Pending","value":{"type":"payout","merchantAccountId":"aadf8010-4df3-49c6-96c0-9f175f60ef36","merchantTransactionId":"a8876gha-ph67-67fg-js06-2ad06sk9fp7c","reference":"ABC23","id":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","code":"1000","message":"Approved","status":"PENDING","payout":{"type":"UNKNOWN"},"psp":{"name":"Nuvei","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c","message":"psp-response"},"hashCode":"90c3b3881074021383c8679f0232580f7b96cebacab77517fc4b479e6d977b06"}},"Approved":{"summary":"Payout Approved","value":{"type":"payout","merchantAccountId":"aadf8010-4df3-49c6-96c0-9f175f60ef36","merchantTransactionId":"a8876gha-ph67-67fg-js06-2ad06sk9fp7c","reference":"ABC23","id":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","code":"1000","message":"Approved","status":"APPROVED","payout":{"type":"FAST_FUNDS"},"psp":{"name":"Braintree","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c","message":"psp-response"},"hashCode":"90c3b3881074021383c8679f0232580f7b96cebacab77517fc4b479e6d977b06","notificationMetadata":{"source":"PSP_WEBHOOK","entity":"PAYOUT","eventTimestamp":1734000000000}}},"Declined":{"summary":"Payout Declined","value":{"type":"payout","merchantAccountId":"aadf8010-4df3-49c6-96c0-9f175f60ef36","merchantTransactionId":"a8876gha-ph67-67fg-js06-2ad06sk9fp7c","reference":"ABC23","id":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","code":"4252","message":"Transaction Error: Maximum number of attempts to process request reached","status":"DECLINED","payout":{"type":"UNKNOWN"},"psp":{"name":"Checkout.com","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c","message":"Transaction Error: Maximum number of attempts to process request reached"},"hashCode":"90c3b3881074021383c8679f0232580f7b96cebacab77517fc4b479e6d977b06"}},"Rejected":{"summary":"Payout Rejected by Issuing Bank","value":{"type":"payout","merchantAccountId":"aadf8010-4df3-49c6-96c0-9f175f60ef36","merchantTransactionId":"a8876gha-ph67-67fg-js06-2ad06sk9fp7c","reference":"ABC23","id":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","code":"4622","message":"Payout Error: Card not eligible for desired payout.","status":"REJECTED","payout":{"type":"UNKNOWN"},"psp":{"name":"Checkout.com","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c","message":"Transaction Error: Maximum number of attempts to process request reached"},"hashCode":"90c3b3881074021383c8679f0232580f7b96cebacab77517fc4b479e6d977b06"}}}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}}}},"get":{"tags":["Payouts"],"summary":"Query Payouts","description":"Search for payouts","operationId":"getPayoutsUsingGET","security":[{"ServerApiKey":[]}],"parameters":[{"name":"merchantTransactionId","in":"query","required":true,"description":"The unique identifier that was set in `POST /v1/payouts`.","schema":{"$ref":"#/components/schemas/MerchantTransactionId"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPayoutResponseList"},"examples":{"payout-pending":{"summary":"Payout Pending","value":[{"paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","timestamp":"2022-01-30T10:10:10Z","code":"1000","message":"Approved","status":"PENDING","paymentInstrument":{"type":"card","nameOnCard":"John F Doe","pan":"1233 56** **** 1133","expiryDate":"06-30","fingerprint":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c6","fingerprintExtended":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c60630","cardMetadata":{"cardBrand":"VISA","issuer":"ACMEBANK","type":"DEBIT","category":"CLASSIC","countryIsoA2":"GB","commercial":true,"bin":"45678765"}},"payoutEligibility":{"crossBorderGambling":"FAST_FUNDS","crossBorderMoneyTransfer":"UNKNOWN","crossBorderNonMoneyTransfer":"NOT_SUPPORTED","domesticGambling":"STANDARD","domesticMoneyTransfer":"FAST_FUNDS","domesticNonMoneyTransfer":"UNKNOWN"},"psp":{"name":"Nuvei","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"},"reference":"example-merchant-payout-refererence"}]},"payout-approved":{"summary":"Payout Approved","value":[{"paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","timestamp":"2022-01-30T10:10:10Z","code":"1000","message":"Approved","status":"APPROVED","paymentInstrument":{"type":"card","nameOnCard":"John F Doe","pan":"1233 56** **** 1133","expiryDate":"06-30","fingerprint":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c6","fingerprintExtended":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c60630","cardMetadata":{"cardBrand":"VISA","issuer":"ACMEBANK","type":"DEBIT","category":"CLASSIC","countryIsoA2":"GB","commercial":true,"bin":"45678765"}},"payoutEligibility":{"crossBorderGambling":"FAST_FUNDS","crossBorderMoneyTransfer":"UNKNOWN","crossBorderNonMoneyTransfer":"NOT_SUPPORTED","domesticGambling":"STANDARD","domesticMoneyTransfer":"FAST_FUNDS","domesticNonMoneyTransfer":"UNKNOWN"},"psp":{"name":"Braintree","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"},"reference":"example-merchant-payout-refererence"}]},"payout-approved-with-psp-token-payment-instrument":{"summary":"Payout Approved (PSP Token)","value":[{"paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","timestamp":"2022-01-30T10:10:10Z","code":"1000","message":"Approved","status":"APPROVED","paymentInstrument":{"type":"pspToken","token":"ABC123","psp":"Braintree","customerId":"customerId"},"psp":{"name":"Braintree","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"},"reference":"example-merchant-payout-refererence"}]},"payout-declined":{"summary":"Payout Declined","value":[{"paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","timestamp":"2022-01-30T10:10:10Z","code":"4252","message":"Transaction Error: Maximum number of attempts to process request reached","status":"DECLINED","paymentInstrument":{"type":"card","nameOnCard":"John F Doe","pan":"1233 56** **** 1133","expiryDate":"06-30","fingerprint":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c6","fingerprintExtended":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c60630","cardMetadata":{"cardBrand":"VISA","issuer":"ACMEBANK","type":"DEBIT","category":"CLASSIC","countryIsoA2":"GB","commercial":true,"bin":"45678765"}},"payoutEligibility":{"crossBorderGambling":"FAST_FUNDS","crossBorderMoneyTransfer":"UNKNOWN","crossBorderNonMoneyTransfer":"NOT_SUPPORTED","domesticGambling":"STANDARD","domesticMoneyTransfer":"FAST_FUNDS","domesticNonMoneyTransfer":"UNKNOWN"},"psp":{"name":"Checkout.com","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"},"reference":"example-merchant-payout-refererence"}]},"payout-rejected":{"summary":"Payout Rejected by Issuing Bank","value":[{"paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","timestamp":"2022-01-30T10:10:10Z","code":"4622","message":"Payout Error: Card not eligible for desired payout.","status":"REJECTED","paymentInstrument":{"type":"card","nameOnCard":"John F Doe","pan":"1233 56** **** 1133","expiryDate":"06-30","fingerprint":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c6","fingerprintExtended":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c60630","cardMetadata":{"cardBrand":"VISA","issuer":"ACMEBANK","type":"DEBIT","category":"CLASSIC","countryIsoA2":"GB","commercial":true,"bin":"45678765"}},"payoutEligibility":{"crossBorderGambling":"FAST_FUNDS","crossBorderMoneyTransfer":"UNKNOWN","crossBorderNonMoneyTransfer":"NOT_SUPPORTED","domesticGambling":"STANDARD","domesticMoneyTransfer":"FAST_FUNDS","domesticNonMoneyTransfer":"UNKNOWN"},"psp":{"name":"Checkout.com","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"},"reference":"example-merchant-payout-refererence"}]},"payout-with-cashierId":{"summary":"Payout With Cashier Id","value":[{"paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","timestamp":"2022-01-30T10:10:10Z","code":"1000","message":"Approved","status":"APPROVED","paymentInstrument":{"type":"paysafecard"},"psp":{"name":"Paysafecard","transactionId":"out_1020015172_WSqy3dHwH56gwk3x2beb76eoHRUpEqQ9_GBP"},"reference":"vJQZjYoShZClEMMElOGoTvNrmVzVhSzCEmJ","cashierId":"43ee1f43-df8b-47df-9b7d-33e3f69879b1"}]},"payout-blocked":{"summary":"Payout Blocked","description":"A payout blocked due to routing rules, the blocking rule is provided in the response.\n","value":[{"paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","merchantTransactionId":"260cd800-5d9d-401b-a5c7-219d0095ac09","code":"4805","message":"Blocked by Routing Rules","timestamp":"2022-01-30T10:10:10Z","status":"BLOCKED","paymentInstrument":{"type":"card","nameOnCard":"John F Doe","pan":"1233 56** **** 1133","expiryDate":"06-30","cardMetadata":{"cardBrand":"VISA","issuer":"ACMEBANK","type":"PREPAID","category":"CLASSIC","countryIsoA2":"GB","commercial":true,"bin":"45678765"},"fingerprint":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c6","fingerprintExtended":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c60630"},"payoutEligibility":{"crossBorderGambling":"UNKNOWN","crossBorderMoneyTransfer":"UNKNOWN","crossBorderNonMoneyTransfer":"UNKNOWN","domesticGambling":"UNKNOWN","domesticMoneyTransfer":"UNKNOWN","domesticNonMoneyTransfer":"UNKNOWN"},"reference":"example-merchant-payout-reference","riskAssessments":{},"customMetadata":{},"amount":1000,"currencyCode":"GBP","blockingRule":{"name":"Block pre-paid cards"}}]},"No payout could be found":{"value":[]}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/UnauthorizedRequest"},"500":{"$ref":"#/components/responses/UnknownServerError"}}}},"/payouts/{paymentId}/status":{"get":{"tags":["Payouts"],"summary":"Get the status of a payout","description":"Returns the status of a payout\n","operationId":"getPayoutStatusUsingGET","security":[{"ServerApiKey":[]}],"parameters":[{"$ref":"#/components/parameters/pathPaymentId"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutStatusResponse"},"examples":{"payout-pending":{"summary":"Payout Pending","value":{"paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","timestamp":"2022-01-30T10:10:10Z","code":"1000","message":"Approved","status":"PENDING","amount":1500,"currencyCode":"GBP","paymentInstrument":{"type":"card","nameOnCard":"John F Doe","pan":"1233 56** **** 1133","expiryDate":"06-30","fingerprint":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c6","fingerprintExtended":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c60630","cardMetadata":{"cardBrand":"VISA","issuer":"ACMEBANK","type":"DEBIT","category":"CLASSIC","countryIsoA2":"GB","commercial":true,"bin":"45678765"}},"payoutEligibility":{"crossBorderGambling":"FAST_FUNDS","crossBorderMoneyTransfer":"UNKNOWN","crossBorderNonMoneyTransfer":"NOT_SUPPORTED","domesticGambling":"STANDARD","domesticMoneyTransfer":"FAST_FUNDS","domesticNonMoneyTransfer":"UNKNOWN"},"psp":{"name":"Nuvei","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"},"reference":"example-merchant-payout-refererence"}},"payout-approved":{"summary":"Payout Approved","value":{"paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","timestamp":"2022-01-30T10:10:10Z","code":"1000","message":"Approved","status":"APPROVED","amount":1500,"currencyCode":"GBP","paymentInstrument":{"type":"card","nameOnCard":"John F Doe","pan":"1233 56** **** 1133","expiryDate":"06-30","fingerprint":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c6","fingerprintExtended":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c60630","cardMetadata":{"cardBrand":"VISA","issuer":"ACMEBANK","type":"DEBIT","category":"CLASSIC","countryIsoA2":"GB","commercial":true,"bin":"45678765"}},"payoutEligibility":{"crossBorderGambling":"FAST_FUNDS","crossBorderMoneyTransfer":"UNKNOWN","crossBorderNonMoneyTransfer":"NOT_SUPPORTED","domesticGambling":"STANDARD","domesticMoneyTransfer":"FAST_FUNDS","domesticNonMoneyTransfer":"UNKNOWN"},"psp":{"name":"Braintree","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"},"reference":"example-merchant-payout-refererence"}},"payout-approved-with-psp-token-payment-instrument":{"summary":"Payout Approved (PSP Token)","value":{"paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","timestamp":"2022-01-30T10:10:10Z","code":"1000","message":"Approved","status":"APPROVED","amount":1500,"currencyCode":"GBP","paymentInstrument":{"type":"pspToken","token":"ABC123","psp":"Braintree","customerId":"customerId"},"psp":{"name":"Braintree","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"},"reference":"example-merchant-payout-refererence"}},"payout-declined":{"summary":"Payout Declined","value":{"paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","timestamp":"2022-01-30T10:10:10Z","code":"4252","message":"Transaction Error: Maximum number of attempts to process request reached","status":"DECLINED","amount":1500,"currencyCode":"GBP","paymentInstrument":{"type":"card","nameOnCard":"John F Doe","pan":"1233 56** **** 1133","expiryDate":"06-30","fingerprint":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c6","fingerprintExtended":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c60630","cardMetadata":{"cardBrand":"VISA","issuer":"ACMEBANK","type":"DEBIT","category":"CLASSIC","countryIsoA2":"GB","commercial":true,"bin":"45678765"}},"payoutEligibility":{"crossBorderGambling":"FAST_FUNDS","crossBorderMoneyTransfer":"UNKNOWN","crossBorderNonMoneyTransfer":"NOT_SUPPORTED","domesticGambling":"STANDARD","domesticMoneyTransfer":"FAST_FUNDS","domesticNonMoneyTransfer":"UNKNOWN"},"psp":{"name":"Checkout.com","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"},"reference":"example-merchant-payout-refererence"}},"payout-rejected":{"summary":"Payout Rejected by Issuing Bank","value":{"paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","timestamp":"2022-01-30T10:10:10Z","code":"4622","message":"Payout Error: Card not eligible for desired payout.","status":"REJECTED","amount":1500,"currencyCode":"GBP","paymentInstrument":{"type":"card","nameOnCard":"John F Doe","pan":"1233 56** **** 1133","expiryDate":"06-30","fingerprint":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c6","fingerprintExtended":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c60630","cardMetadata":{"cardBrand":"VISA","issuer":"ACMEBANK","type":"DEBIT","category":"CLASSIC","countryIsoA2":"GB","commercial":true,"bin":"45678765"}},"payoutEligibility":{"crossBorderGambling":"FAST_FUNDS","crossBorderMoneyTransfer":"UNKNOWN","crossBorderNonMoneyTransfer":"NOT_SUPPORTED","domesticGambling":"STANDARD","domesticMoneyTransfer":"FAST_FUNDS","domesticNonMoneyTransfer":"UNKNOWN"},"psp":{"name":"Checkout.com","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"},"reference":"example-merchant-payout-refererence"}},"payout-with-cashierId":{"summary":"Payout With Cashier Id","value":{"paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","timestamp":"2022-01-30T10:10:10Z","code":"1000","message":"Approved","status":"APPROVED","amount":1500,"currencyCode":"GBP","paymentInstrument":{"type":"paysafecard"},"psp":{"name":"Paysafecard","transactionId":"out_1020015172_WSqy3dHwH56gwk3x2beb76eoHRUpEqQ9_GBP"},"reference":"vJQZjYoShZClEMMElOGoTvNrmVzVhSzCEmJ","cashierId":"43ee1f43-df8b-47df-9b7d-33e3f69879b1"}},"payout-with-custom-metadata":{"summary":"Payout Pending with custom metadata","value":{"paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","timestamp":"2022-01-30T10:10:10Z","code":"1000","message":"Approved","status":"PENDING","amount":1500,"currencyCode":"GBP","paymentInstrument":{"type":"card","nameOnCard":"John F Doe","pan":"1233 56** **** 1133","expiryDate":"06-30","fingerprint":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c6","fingerprintExtended":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c60630","cardMetadata":{"cardBrand":"VISA","issuer":"ACMEBANK","type":"DEBIT","category":"CLASSIC","countryIsoA2":"GB","commercial":true,"bin":"45678765"}},"payoutEligibility":{"crossBorderGambling":"FAST_FUNDS","crossBorderMoneyTransfer":"UNKNOWN","crossBorderNonMoneyTransfer":"NOT_SUPPORTED","domesticGambling":"STANDARD","domesticMoneyTransfer":"FAST_FUNDS","domesticNonMoneyTransfer":"UNKNOWN"},"psp":{"name":"Nuvei","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"},"reference":"example-merchant-payout-refererence","customMetadata":{"accountAge":"2","transactionType":"Other"}}},"payout-blocked":{"summary":"Payout Blocked","description":"A payout blocked due to routing rules, the blocking rule is provided in the response.\n","value":{"paymentId":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","code":"4805","message":"Blocked by Routing Rules","timestamp":"2022-01-30T10:10:10Z","status":"BLOCKED","paymentInstrument":{"type":"card","nameOnCard":"John F Doe","pan":"1233 56** **** 1133","expiryDate":"06-30","cardMetadata":{"cardBrand":"VISA","issuer":"ACMEBANK","type":"PREPAID","category":"CLASSIC","countryIsoA2":"GB","commercial":true,"bin":"45678765"},"fingerprint":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c6","fingerprintExtended":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c60630"},"payoutEligibility":{"crossBorderGambling":"UNKNOWN","crossBorderMoneyTransfer":"UNKNOWN","crossBorderNonMoneyTransfer":"UNKNOWN","domesticGambling":"UNKNOWN","domesticMoneyTransfer":"UNKNOWN","domesticNonMoneyTransfer":"UNKNOWN"},"reference":"example-merchant-payout-reference","amount":1500,"currencyCode":"GBP","blockingRule":{"name":"Block pre-paid cards"}}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedRequest"},"404":{"$ref":"#/components/responses/EntityNotFound"},"500":{"$ref":"#/components/responses/UnknownServerError"}}}}},"components":{"schemas":{"PaymentRequest":{"title":"Payment","description":"Represents a request to transfer funds between accounts at banks or other financial institutions.\n","required":["amount","currencyCode","customerOrderCode","orderDescription","paymentInstrument"],"type":"object","properties":{"amount":{"$ref":"#/components/schemas/AmountIncludingZero"},"billingAddress":{"$ref":"#/components/schemas/Address"},"browserData":{"$ref":"#/components/schemas/BrowserData"},"channel":{"type":"string","enum":["web","ios","android","WEB","IOS","ANDROID"],"example":"web","description":"The type of channel used by the end user for the payment.\nE.g. If your user is using an iOS app to checkout then channel would be `ios`.\n\nThis data is required by some Payment Service Providers as part of their 3-D Secure flow.\nIf you are unsure whether you need to collect this data, please raise a ticket\nwith support on the BR-DGE Support Portal at\n<https://docs.br-dge.io/docs/support#contact-support>."},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"customerDateOfBirth":{"$ref":"#/components/schemas/DateOfBirth"},"customerEmail":{"maxLength":254,"minLength":1,"pattern":"^$|^[a-zA-Z0-9._%'+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$","type":"string","description":"Email address of the customer\nWhile this field is not required by the BR-DGE API; it is highly\nrecommended as some PSPs consider this a mandatory field.\nIf you have any questions about whether you should provide customer\nemail address, please raise a ticket with the\n[BR-DGE Support Centre](https://support.br-dge.io/support/home)","example":"a@b.com"},"customerFirstName":{"description":"First name of the customer (customerFirstName length plus customerLastName length must be less than 255 characters long) Please use only letters, spaces and these symbols: `-'.` While this field is not required by the BR-DGE API; it is highly recommended as some PSPs consider this a mandatory field. If you have any questions about whether you should provide customer first name, please raise a ticket with the [BR-DGE Support Centre](https://support.br-dge.io/support/home)","type":"string","minLength":1,"maxLength":255,"example":"John"},"customerId":{"$ref":"#/components/schemas/CustomerId"},"customerIpAddress":{"$ref":"#/components/schemas/IpAddress"},"customerLastName":{"description":"Last name of the customer (customerFirstName length plus customerLastName length must be less than 255 characters long)\nPlease use only letters, spaces and these symbols: -'.","type":"string","maxLength":255,"example":"Smith"},"customerOrderCode":{"allOf":[{"$ref":"#/components/schemas/CustomerOrderCode"}],"description":"Merchant’s own identifier for the transaction, which can be used to find the transaction in BR-DGE Portal.\nThis value will also be passed on to payment service providers if possible.\n\n\nPlease use only letters, numbers, spaces and these symbols:'[]()@?!\\-/.,_&*:;+="},"customerPhoneNumber":{"maxLength":255,"pattern":"^$|^[+]?[(0-9][0-9 ()-]*[0-9]$","type":"string","description":"Telephone number of the customer\nPlease use only numbers, spaces and an optional leading +.","example":"+44 123 1110000"},"customerSessionId":{"$ref":"#/components/schemas/CustomerSessionId"},"deliveryAddress":{"$ref":"#/components/schemas/Address"},"documentId":{"maxLength":255,"type":"string","description":"Required for some payment instruments. Please refer to the payment instrument schema\ndocumentation to see if this is required and where to source the data.","example":"ABC-123456"},"documentType":{"maxLength":255,"type":"string","description":"The type of identification document. E.g. passport, national identity card, tax ID, etc.\nRequired for some payment instruments. Please refer to the payment instrument schema documentation to see if this is required and where to source the data.\n","example":"DNI"},"intent":{"type":"string","default":"capture","description":"By default payments are captured immediately, but you can you can choose to split the authorization and the capture of the payment.\n * `authorize` - if you intend to capture separately using\n   `POST /payments/{paymentId}/capture`\n * `capture` - If you intend to capture immediately\n","enum":["authorize","capture"]},"merchantInitiated":{"type":"string","description":"Payments made via BR-DGE are assumed to be Cardholder Initiated Transactions (CIT) unless flagged as Merchant Initiated (MIT).\n\nMerchants commonly initiate MITs without the active participation of the cardholder to:\n- Perform a transaction as a follow-up to a cardholder-initiated transaction (CIT)\n- Perform a pre-agreed standing instruction from the cardholder for the provision of goods or services\n\nExamples of MITs include:\n- An unscheduled charge for a service such as e-scooter hire\n- A recurring payment for a magazine subscription\n\nYou must enter into an agreement with your customer prior to performing MITs, and must use a BR-DGE Card on File Payment Instrument.\n","enum":["unscheduled","recurring"]},"merchantInitiatedDetails":{"$ref":"#/components/schemas/MerchantInitiatedDetails"},"orderDescription":{"maxLength":255,"minLength":1,"type":"string","description":"Description of what the payment is for\nPlease use only letters, numbers, spaces and these symbols:'[]()@?!\\-/.,_&*:;+=","example":"Taxi fare"},"origin":{"type":"string","maxLength":255,"minLength":1,"example":"https://example-store.org:8080","description":"The origin URL of the web page used by the end user for the payment,\nif the `channel` is `web`.\n\nThis data is required by some payment service providers (PSPs) as part of their\n3-D Secure flow.\nIf you are unsure whether you need to collect this data, please raise a ticket with\nsupport on the BR-DGE Support Portal at\n<https://docs.br-dge.io/docs/support#contact-support>."},"paymentInstrument":{"$ref":"#/components/schemas/PaymentInstrument"},"threeDSecureOptions":{"$ref":"#/components/schemas/ThreeDSecureOptions"},"threeDSecureRequired":{"type":"boolean","description":"You can indicate that 3-D Secure processing is preferred, usually initializing a 3-D Secure authentication flow.\n\nNote that setting this as true does not guarantee that the payment will end up with successful 3-D Secure authentication. Also, setting this to false does not guarantee that 3-D Secure authentication will not be applied to the payment, as some PSPs may choose to apply their own rules around this regardless need to opt-in to 3-D Secure authentication on a per-payment basis.\n","example":true},"externalThreeDSecure":{"$ref":"#/components/schemas/ExternalThreeDSecure"},"ignoreAvs":{"type":"boolean","description":"You can tell the payment processors to ignore the result of their Address Verification Service (AVS) and process the Payment regardless. This is false by default.\n\nNote this only applies to some payment processors. Speak to your payment processor to find out how you can ignore their AVS otherwise.\n","example":true},"riskInstruments":{"$ref":"#/components/schemas/RiskInstruments"},"cashierId":{"$ref":"#/components/schemas/CashierId"},"merchantTransactionId":{"$ref":"#/components/schemas/MerchantTransactionId"},"scaExemption":{"type":"string","description":"This field allows you to specify a reason for exempting a transaction from Strong Customer Authentication (SCA).\n- LOW_VALUE - Low-Value Transaction. Use this value if the transaction amount is below the threshold for SCA exemption.\n- TRA - Transaction Risk Analysis. Use this value if you believe the transaction has a low risk of fraud based on your own risk assessment.\n\nNOTE: Even with a valid exemption reason, the card issuer has the final say in whether to grant the exemption.\n","enum":["LOW_VALUE","TRA"],"example":"TRA"},"aft":{"type":"object","description":"Indicates if the payment is an Account Funding Transaction.\n\nPlease provide the required sender and recipient data required by the PSP of choice.\n","properties":{"fundingPurpose":{"type":"string","enum":["DONATIONS","EDUCATION","FAMILY_SUPPORT","GIFTS","LOAN_PAYMENT","MEDICAL_TREATMENT","OTHER","SAVINGS"],"description":"The funding purpose of the AFT payment.\n"},"fundingType":{"type":"string","enum":["PERSON_TO_PERSON","DIGITAL_WALLET_TOP_UP"],"description":"The funding type of the AFT payment.\n"}}},"recipient":{"$ref":"#/components/schemas/PaymentRecipient"},"customMetadata":{"$ref":"#/components/schemas/CustomMetadata"}}},"CustomerSessionId":{"title":"Customer Session ID","type":"string","maxLength":255,"description":"Session Id of the customer\nPlease use only letters, numbers, spaces and these symbols:'[]()@?!\\-/.,_&*:;+=","example":"123456"},"Address":{"title":"Address","allOf":[{"type":"object","properties":{"firstName":{"description":"First name of the occupant.\n\nPlease use only letters, spaces and these symbols: `-'.`","type":"string","maxLength":255,"example":"John"},"lastName":{"description":"Last name of the occupant.\n\nPlease use only letters, spaces and these symbols: `-'.`","type":"string","maxLength":255,"example":"Smith"},"phoneNumber":{"$ref":"#/components/schemas/PhoneNumber"}}},{"$ref":"#/components/schemas/DomicileAddress"}]},"DomicileAddress":{"title":"Address","type":"object","properties":{"buildingNumberOrName":{"$ref":"#/components/schemas/BuildingNumberOrName"},"address1":{"$ref":"#/components/schemas/AddressLineOne"},"address2":{"$ref":"#/components/schemas/AddressLineTwo"},"address3":{"$ref":"#/components/schemas/AddressLineThree"},"town":{"$ref":"#/components/schemas/Town"},"county":{"$ref":"#/components/schemas/County"},"postcode":{"$ref":"#/components/schemas/Postcode"},"country":{"$ref":"#/components/schemas/CountryIsoCode"},"countrySubdivisionCode":{"description":"ISO 3166-2 Country subdivision code.\n\nFor an ISO 3166-2 code like `GB-SCT` you should only provide `SCT`.","type":"string","minLength":1,"maxLength":3,"pattern":"^[A-Z0-9]+$","example":"WY"}}},"BrowserData":{"title":"BrowserData","description":"Information about the browser used to collect payment details.\n\nThis data is required by some Payment Service Providers as part of their 3-D Secure flow. If you are unsure whether you need to collect this data, please raise a ticket with support on the BR-DGE Support Portal at <https://docs.br-dge.io/docs/support#contact-support>.\n","type":"object","properties":{"acceptHeader":{"type":"string","description":"Exact content of the HTTP accept headers as sent to the merchant from the cardholders browser.\n","example":"application/json"},"colorDepth":{"type":"string","description":"Value representing the bit depth of the color palette for displaying images, in bits per pixel. Obtained from cardholder browser using the `screen.colorDepth` browser property.","example":"32"},"javaEnabled":{"type":"boolean","description":"Boolean that represents the ability of the cardholder browser to execute java. Value is returned from the `navigator.javaEnabled` browser property.","example":true},"language":{"type":"string","description":"Value representing the browser language as defined in IETF BCP47. Returned from `navigator.language` browser property.","example":"en-GB"},"screenHeight":{"type":"integer","description":"Total height of the cardholders screen in pixels. Value is returned from the `screen.height` browser property.","format":"int32","example":768},"screenWidth":{"type":"integer","description":"Total width of the cardholders screen in pixels. Value is returned from the `screen.width` browser property.","format":"int32","example":1024},"timeZone":{"type":"integer","description":"Time difference between UTC time and the cardholder browser local time, in minutes.\n\nThis can be retrieved by running `new Date().getTimezoneOffset();` within the browser.","format":"int32","example":800},"userAgent":{"type":"string","description":"Exact content of the HTTP user-agent header, as sent to the merchant from the cardholders browser.","example":"Mozilla/5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/67.0.3396.99 Safari/537.36"}}},"ExternalThreeDSecure":{"description":"If you want to use an independent 3-D Secure service to authenticate your payment, then you can do so prior to submitting your payment to BR-DGE.\n\nYour client app sends the payment details to your server.\n\nYour server submits the payment to your 3-D Secure Authentication Service\n\nThe 3-D Authentication service will authenticate the payment and return the authentication results back to your server. It will include several fields that can be used by the issuer to confirm the authentication results as part of approving the payment.\n\nAfter authentication, the results can be added to the payment and submitted to BR-DGE for processing. Click here for details on the fields that can be included in the BR-DGE API\n","type":"object","properties":{"eci":{"type":"string","description":"The Electronic Commerce Indicator (ECI) indicates the type of card holder authentication used for the transaction.\n\nFor Secure, Authenticated transaction with XID and CAVV present ECI is set to \"05\" (Visa & eftpos) or \"02\" (Mastercard). For Secure, Non-authenticated transaction (XID present, CAVV not present) ECI is set to \"06\" (Visa & eftpos) or \"01\" (Mastercard). For Secure, Non-authenticated transaction (XID and CAVV not present) ECI is set to \"07\" (Visa & eftpos) or \"00\" (Mastercard).\n","example":"05"},"cavv":{"type":"string","description":"The CAVV is the card authentication verification value, provided by the 3D Secure Provider. This is Base64 encoded data.","example":"MzM2OGI2ZjkwYjYwY2FjODQ3ZWU="},"xid":{"type":"string","description":"The XID is the transaction ID from the 3D Secure provider. This is Base64 encoded data.","example":"ZGUzNzgwYzQxM2ZlMWM0MzVkMjc="},"par":{"type":"string","description":"This is the PARes value from 3D Secure","example":"Y"},"ver":{"type":"string","description":"This is the VERes value from 3D Secure","example":"Y"},"threeDSecureVersion":{"type":"string","description":"3DS version used for authenticating the card. The version may include the major, minor, and build numbers, e.g. 2, 2.1, or 2.1.0 are all accepted values. If omitted, this field will default to a value of 1.","example":"2.1.0"},"dsTransactionId":{"type":"string","description":"Directory Server Transaction ID from the 3D Secure provider. This is commonly a string in UUID format.","example":"2.1.0"}}},"PaymentResponse":{"description":"The response from a payment request.","allOf":[{"$ref":"#/components/schemas/ComcardeResponse"},{"$ref":"#/components/schemas/RelationshipEntity"},{"$ref":"#/components/schemas/IncludedRelationships"},{"type":"object","title":"PaymentResponse","properties":{"paymentId":{"type":"string","description":"The ID of this payment","example":"57f7f444-29ce-4230-8c7f-1c1fd85c8bc9"},"amount":{"$ref":"#/components/schemas/AmountIncludingZero"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"threeDSecureAction":{"type":"object","additionalProperties":{"type":"string"},"description":"An object that contains values used to continue a 3-D Secure payment.\n\nNote: this field is now deprecated, and the 'action' field should be used instead.\n","deprecated":true},"actionRequired":{"type":"boolean","description":"Boolean value indicating whether further action should be taken after the response is received","example":true},"action":{"$ref":"#/components/schemas/Action"},"installmentsPlan":{"$ref":"#/components/schemas/InstallmentsPlan"},"token":{"type":"string","description":"Multi-use token for Card on File, if the request asked for one to be created.\n","example":"7685edd8-006b-4526-85ce-c8b31addcea6"},"psp":{"$ref":"#/components/schemas/PspInfo"},"pspId":{"type":"string","description":"Deprecated. Use `psp` object instead.","deprecated":true},"riskAssessments":{"$ref":"#/components/schemas/RiskAssessments"},"customerOrderCode":{"allOf":[{"$ref":"#/components/schemas/CustomerOrderCode"}],"description":"Merchant's own identifier for the transaction, which can be used to find the transaction in BR-DGE Portal.\n","example":"ABC123"},"merchantTransactionId":{"$ref":"#/components/schemas/MerchantTransactionId"},"paymentRails":{"$ref":"#/components/schemas/PaymentRails"},"avsResult":{"$ref":"#/components/schemas/AvsResult"},"cvvResult":{"$ref":"#/components/schemas/CvvResult"},"paymentInstrument":{"$ref":"#/components/schemas/PaymentInstrumentPaymentResponse"},"scaDetails":{"$ref":"#/components/schemas/ScaDetails"},"authentication":{"$ref":"#/components/schemas/Authentication"},"authorizationCode":{"$ref":"#/components/schemas/AuthorizationCode"},"blockingRule":{"$ref":"#/components/schemas/BlockingRule"},"processedAsAft":{"$ref":"#/components/schemas/ProcessedAsAft"},"pspProcessingMethod":{"$ref":"#/components/schemas/PspProcessingMethod"}}}]},"ProcessedAsAft":{"title":"ProcessedAsAft","type":"string","description":"Indicator whether the payment was processed as an AFT. `UNKNOWN` when the provider does not report either way. Only present for payments submitted with an `aft` object.\n","enum":["YES","NO","UNKNOWN"],"example":"YES"},"PspProcessingMethod":{"title":"PspProcessingMethod","type":"string","description":"The type of payment credential BR-DGE submitted to the provider to process this transaction, typically `RAW_CARD_DETAILS`, `NETWORK_TOKEN`, `PSP_TOKEN` or `OTHER`. Describes what BR-DGE sent to the provider, not what the provider used. Omitted when no credential type was recorded.\n","example":"NETWORK_TOKEN"},"ResponseWithPsp":{"allOf":[{"$ref":"#/components/schemas/ComcardeResponse"},{"type":"object","title":"ResponseWithPsp","properties":{"psp":{"$ref":"#/components/schemas/PspInfo"}}}]},"TransactionStatusBase":{"type":"object","required":["paymentId","code","message","timestamp"],"properties":{"paymentId":{"type":"string","description":"Unique identifier for the payment","example":"2c6a34be-f7a1-4b49-b09c-e84e1322df7f"},"merchantTransactionId":{"$ref":"#/components/schemas/MerchantTransactionId"},"customer":{"type":"object","description":"Information pertaining to the customer whom made the transaction.","required":["id"],"properties":{"id":{"$ref":"#/components/schemas/CustomerId"}}},"code":{"type":"string","description":"[Response Code] signifying the outcome of the request.\n\n[Response Code]: https://docs.br-dge.io/docs/response-codes\n","example":"1000"},"message":{"type":"string","description":"A description of the outcome"},"psp":{"$ref":"#/components/schemas/PspInfo"},"timestamp":{"type":"string","description":"Timestamp when the transaction entered its latest status.","format":"date-time","example":"2022-01-30T10:10:10Z"}}},"VoidResponse":{"allOf":[{"$ref":"#/components/schemas/ResponseWithPsp"},{"type":"object"}]},"CaptureResponse":{"allOf":[{"$ref":"#/components/schemas/ResponseWithPsp"},{"type":"object","title":"CaptureResponse","description":"Response following a capture request"}]},"RefundResponse":{"allOf":[{"$ref":"#/components/schemas/ResponseWithPsp"},{"type":"object","properties":{"installmentsPlan":{"$ref":"#/components/schemas/InstallmentsPlan"},"merchantTransactionId":{"$ref":"#/components/schemas/MerchantTransactionId"},"customerRefundCode":{"$ref":"#/components/schemas/CustomerRefundCode"}}}]},"InstallmentsPlan":{"title":"InstallmentsPlan","description":"Information about any installments plan was that was linked to the payment request and the outcome of its activation or acceptance.\n","type":"object","properties":{"code":{"type":"string","description":"[Response Code](https://docs.br-dge.io/docs/response-codes) signifying the outcome of the request.\n","example":"1000"},"message":{"type":"string","description":"A description of the outcome of the request.","example":"Approved"},"provider":{"type":"string","description":"Full name of the provider of this installments plan.","example":"Visa Installments"},"operation":{"type":"string","description":"The type of operation being made: Activation: a new plan has been activated Cancellation: an existing plan has been cancelled\n","example":"cancellation"},"planActivationId":{"type":"string","description":"Unique code that identifies the acceptance or activation of the installments plan. This code comes from the installments plan provider, not from BR-DGE.\n","example":"6ccc5c91-f869-4063-9368-40b4cb30c6ce"}}},"GetRefundsResponseList":{"type":"array","items":{"$ref":"#/components/schemas/GetRefundsResponse"}},"GetRefundsResponse":{"allOf":[{"$ref":"#/components/schemas/TransactionStatusBase"},{"type":"object","required":["paymentInstrument","status","amount"],"properties":{"paymentInstrument":{"$ref":"#/components/schemas/PaymentStatusPaymentInstrument"},"status":{"$ref":"#/components/schemas/RefundStatus"},"merchantTransactionId":{"$ref":"#/components/schemas/MerchantTransactionId"},"amount":{"$ref":"#/components/schemas/Amount"},"customerRefundCode":{"$ref":"#/components/schemas/CustomerRefundCode"}}}]},"GetPaymentResponseList":{"description":"Payments matching the get payments request","type":"array","items":{"$ref":"#/components/schemas/GetPaymentResponse"}},"GetPaymentResponse":{"description":"Information about a Payment transaction","allOf":[{"$ref":"#/components/schemas/TransactionStatusBase"},{"$ref":"#/components/schemas/RelationshipEntity"},{"$ref":"#/components/schemas/IncludedRelationships"},{"type":"object","required":["paymentInstrument","status","reference","merchantTransactionId","amount","currencyCode","blockingRule"],"properties":{"paymentInstrument":{"$ref":"#/components/schemas/PaymentStatusPaymentInstrument"},"status":{"$ref":"#/components/schemas/PaymentStatus"},"reference":{"description":"The merchant defined customer order code for the payment.","type":"string"},"riskAssessments":{"$ref":"#/components/schemas/RiskAssessments"},"cashierId":{"$ref":"#/components/schemas/CashierId"},"merchantTransactionId":{"$ref":"#/components/schemas/MerchantTransactionId"},"paymentRails":{"$ref":"#/components/schemas/PaymentRails"},"avsResult":{"$ref":"#/components/schemas/AvsResult"},"cvvResult":{"$ref":"#/components/schemas/CvvResult"},"amount":{"$ref":"#/components/schemas/AmountIncludingZero"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"scaDetails":{"$ref":"#/components/schemas/ScaDetails"},"authentication":{"$ref":"#/components/schemas/Authentication"},"authorizationCode":{"$ref":"#/components/schemas/AuthorizationCode"},"blockingRule":{"$ref":"#/components/schemas/BlockingRule"},"processedAsAft":{"$ref":"#/components/schemas/ProcessedAsAft"},"pspProcessingMethod":{"$ref":"#/components/schemas/PspProcessingMethod"}}}]},"PaymentStatusResponse":{"allOf":[{"$ref":"#/components/schemas/TransactionStatusBase"},{"$ref":"#/components/schemas/RelationshipEntity"},{"$ref":"#/components/schemas/IncludedRelationships"},{"type":"object","required":["paymentInstrument","status","reference","amount","currencyCode"],"properties":{"paymentInstrument":{"$ref":"#/components/schemas/PaymentStatusPaymentInstrument"},"status":{"$ref":"#/components/schemas/PaymentStatus"},"reference":{"description":"The merchant defined customer order code for the payment.","type":"string"},"comcardeCode":{"$ref":"#/components/schemas/ComcardeCode"},"riskAssessments":{"$ref":"#/components/schemas/RiskAssessments"},"cashierId":{"$ref":"#/components/schemas/CashierId"},"customMetadata":{"$ref":"#/components/schemas/CustomMetadata"},"paymentRails":{"$ref":"#/components/schemas/PaymentRails"},"keyIdentifiers":{"$ref":"#/components/schemas/KeyIdentifiers"},"avsResult":{"$ref":"#/components/schemas/AvsResult"},"cvvResult":{"$ref":"#/components/schemas/CvvResult"},"amount":{"$ref":"#/components/schemas/AmountIncludingZero"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"scaDetails":{"$ref":"#/components/schemas/ScaDetails"},"authentication":{"$ref":"#/components/schemas/Authentication"},"authorizationCode":{"$ref":"#/components/schemas/AuthorizationCode"},"blockingRule":{"$ref":"#/components/schemas/BlockingRule"},"processedAsAft":{"$ref":"#/components/schemas/ProcessedAsAft"},"pspProcessingMethod":{"$ref":"#/components/schemas/PspProcessingMethod"}}}]},"PaymentStatusPaymentInstrument":{"oneOf":[{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentCard"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentApplePay"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentGooglePay"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentClickToPay"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentPayPal"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentIdeal"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentBancontact"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentTrustly"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentPix"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentPspTokenInstrument"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentAstroPayInstrument"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentPaysafecard"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentEasyPay"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentEPay"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentNeteller"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentSkrill"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentSkrillOneTap"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentRevolutPay"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentTrueLayer"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentOneVoucher"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentBank2Bank"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentOttVoucher"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentBluVoucher"}],"discriminator":{"propertyName":"type","mapping":{"card":"#/components/schemas/PaymentStatusPaymentInstrumentCard","applePay":"#/components/schemas/PaymentStatusPaymentInstrumentApplePay","googlePay":"#/components/schemas/PaymentStatusPaymentInstrumentGooglePay","clickToPay":"#/components/schemas/PaymentStatusPaymentInstrumentClickToPay","payPal":"#/components/schemas/PaymentStatusPaymentInstrumentPayPal","ideal":"#/components/schemas/PaymentStatusPaymentInstrumentIdeal","bancontact":"#/components/schemas/PaymentStatusPaymentInstrumentBancontact","trustly":"#/components/schemas/PaymentStatusPaymentInstrumentTrustly","pix":"#/components/schemas/PaymentStatusPaymentInstrumentPix","pspToken":"#/components/schemas/PaymentStatusPaymentInstrumentPspTokenInstrument","astroPay":"#/components/schemas/PaymentStatusPaymentInstrumentAstroPayInstrument","paysafecard":"#/components/schemas/PaymentStatusPaymentInstrumentPaysafecard","easyPay":"#/components/schemas/PaymentStatusPaymentInstrumentEasyPay","ePay":"#/components/schemas/PaymentStatusPaymentInstrumentEPay","neteller":"#/components/schemas/PaymentStatusPaymentInstrumentNeteller","skrill":"#/components/schemas/PaymentStatusPaymentInstrumentSkrill","skrillOneTap":"#/components/schemas/PaymentStatusPaymentInstrumentSkrillOneTap","revolutPay":"#/components/schemas/PaymentStatusPaymentInstrumentRevolutPay","trueLayer":"#/components/schemas/PaymentStatusPaymentInstrumentTrueLayer","oneVoucher":"#/components/schemas/PaymentStatusPaymentInstrumentOneVoucher","bank2bank":"#/components/schemas/PaymentStatusPaymentInstrumentBank2Bank","ottVoucher":"#/components/schemas/PaymentStatusPaymentInstrumentOttVoucher","bluVoucher":"#/components/schemas/PaymentStatusPaymentInstrumentBluVoucher"}}},"PaymentInstrumentPaymentResponse":{"oneOf":[{"$ref":"#/components/schemas/PaymentInstrumentCard"},{"$ref":"#/components/schemas/PaymentInstrumentApplePay"},{"$ref":"#/components/schemas/PaymentInstrumentGooglePay"},{"$ref":"#/components/schemas/PaymentInstrumentClickToPay"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentPayPal"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentIdeal"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentBancontact"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentTrustly"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentPix"},{"$ref":"#/components/schemas/PaymentInstrumentPspTokenInstrument"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentAstroPayInstrument"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentPaysafecard"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentEasyPay"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentEPay"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentNeteller"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentSkrill"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentRevolutPay"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentTrueLayer"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentOneVoucher"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentBluVoucher"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentBank2Bank"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentOttVoucher"}],"discriminator":{"propertyName":"type","mapping":{"card":"#/components/schemas/PaymentInstrumentCard","applePay":"#/components/schemas/PaymentInstrumentApplePay","googlePay":"#/components/schemas/PaymentInstrumentGooglePay","clickToPay":"#/components/schemas/PaymentInstrumentClickToPay","payPal":"#/components/schemas/PaymentStatusPaymentInstrumentPayPal","ideal":"#/components/schemas/PaymentStatusPaymentInstrumentIdeal","bancontact":"#/components/schemas/PaymentStatusPaymentInstrumentBancontact","trustly":"#/components/schemas/PaymentStatusPaymentInstrumentTrustly","pix":"#/components/schemas/PaymentStatusPaymentInstrumentPix","pspToken":"#/components/schemas/PaymentInstrumentPspTokenInstrument","astroPay":"#/components/schemas/PaymentStatusPaymentInstrumentAstroPayInstrument","paysafecard":"#/components/schemas/PaymentStatusPaymentInstrumentPaysafecard","easyPay":"#/components/schemas/PaymentStatusPaymentInstrumentEasyPay","ePay":"#/components/schemas/PaymentStatusPaymentInstrumentEPay","neteller":"#/components/schemas/PaymentStatusPaymentInstrumentNeteller","skrill":"#/components/schemas/PaymentStatusPaymentInstrumentSkrill","revolutPay":"#/components/schemas/PaymentStatusPaymentInstrumentRevolutPay","trueLayer":"#/components/schemas/PaymentStatusPaymentInstrumentTrueLayer","oneVoucher":"#/components/schemas/PaymentStatusPaymentInstrumentOneVoucher","bluVoucher":"#/components/schemas/PaymentStatusPaymentInstrumentBluVoucher","bank2bank":"#/components/schemas/PaymentStatusPaymentInstrumentBank2Bank","ottVoucher":"#/components/schemas/PaymentStatusPaymentInstrumentOttVoucher"}}},"PaymentInstrumentPayoutResponse":{"oneOf":[{"$ref":"#/components/schemas/PaymentInstrumentApplePay"},{"$ref":"#/components/schemas/PaymentInstrumentCard"},{"$ref":"#/components/schemas/PaymentInstrumentGooglePay"},{"$ref":"#/components/schemas/PaymentInstrumentPspTokenInstrument"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentAstroPayInstrument"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentEPay"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentEasyPay"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentNeteller"},{"$ref":"#/components/schemas/PayoutStatusPaymentInstrumentOtt"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentPaysafecard"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentRevolutPay"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentSkrill"},{"$ref":"#/components/schemas/PayoutStatusPaymentInstrumentAccessWorldpayBankPayout"},{"$ref":"#/components/schemas/PayoutStatusPaymentInstrumentPayPal"},{"$ref":"#/components/schemas/PayoutStatusPaymentInstrumentTrueLayer"},{"$ref":"#/components/schemas/PayoutStatusPaymentInstrumentTrustly"}],"discriminator":{"propertyName":"type","mapping":{"accessWorldpay":"#/components/schemas/PayoutStatusPaymentInstrumentAccessWorldpayBankPayout","applePay":"#/components/schemas/PaymentInstrumentApplePay","astroPay":"#/components/schemas/PaymentStatusPaymentInstrumentAstroPayInstrument","card":"#/components/schemas/PaymentInstrumentCard","ePay":"#/components/schemas/PaymentStatusPaymentInstrumentEPay","easyPay":"#/components/schemas/PaymentStatusPaymentInstrumentEasyPay","googlePay":"#/components/schemas/PaymentInstrumentGooglePay","neteller":"#/components/schemas/PaymentStatusPaymentInstrumentNeteller","ottPayout":"#/components/schemas/PayoutStatusPaymentInstrumentOtt","paypal":"#/components/schemas/PayoutStatusPaymentInstrumentPayPal","paysafecard":"#/components/schemas/PaymentStatusPaymentInstrumentPaysafecard","pspToken":"#/components/schemas/PaymentInstrumentPspTokenInstrument","revolutPay":"#/components/schemas/PaymentStatusPaymentInstrumentRevolutPay","skrill":"#/components/schemas/PaymentStatusPaymentInstrumentSkrill","trueLayer":"#/components/schemas/PayoutStatusPaymentInstrumentTrueLayer","trustly":"#/components/schemas/PayoutStatusPaymentInstrumentTrustly"}}},"BasePaymentStatusPaymentInstrument":{"description":"General fields which are valid for a payment instrument.","type":"object","required":["type"],"properties":{"type":{"description":"Discriminator Field, defines the type of payment instrument.\nValid values can be found on the parent object’s discriminator definition in OpenAPI schema.\n","type":"string"}}},"PaymentStatusPaymentInstrumentCard":{"allOf":[{"$ref":"#/components/schemas/BasePaymentStatusPaymentInstrument"},{"type":"object","required":["pan","expiryDate","fingerprint","fingerprintExtended"],"properties":{"nameOnCard":{"type":"string","example":"John F Doe"},"pan":{"type":"string","example":"1234 56## #### 1111"},"expiryDate":{"$ref":"#/components/schemas/CardExpiryDate"},"cardMetadata":{"$ref":"#/components/schemas/CardMetadata"},"fingerprint":{"$ref":"#/components/schemas/Fingerprint"},"fingerprintExtended":{"$ref":"#/components/schemas/FingerprintExtended"}}}]},"PaymentInstrumentCard":{"allOf":[{"$ref":"#/components/schemas/BasePaymentStatusPaymentInstrument"},{"type":"object"}]},"PaymentStatusPaymentInstrumentApplePay":{"allOf":[{"$ref":"#/components/schemas/BasePaymentStatusPaymentInstrument"},{"$ref":"#/components/schemas/ApplePayDetails"},{"$ref":"#/components/schemas/DeprecatedCardMetadataField"}]},"PaymentInstrumentApplePay":{"allOf":[{"$ref":"#/components/schemas/BasePaymentStatusPaymentInstrument"},{"type":"object"}]},"PaymentStatusPaymentInstrumentGooglePay":{"allOf":[{"$ref":"#/components/schemas/BasePaymentStatusPaymentInstrument"},{"$ref":"#/components/schemas/GooglePayDetails"},{"$ref":"#/components/schemas/DeprecatedCardMetadataField"}]},"PaymentInstrumentGooglePay":{"allOf":[{"$ref":"#/components/schemas/BasePaymentStatusPaymentInstrument"},{"type":"object"}]},"PaymentStatusPaymentInstrumentClickToPay":{"allOf":[{"$ref":"#/components/schemas/BasePaymentStatusPaymentInstrument"},{"$ref":"#/components/schemas/ClickToPayDetails"}]},"PaymentInstrumentClickToPay":{"allOf":[{"$ref":"#/components/schemas/BasePaymentStatusPaymentInstrument"},{"type":"object"}]},"DeprecatedCardMetadataField":{"description":"An object to include the deprecated `cardMetadata` field in the model.\nThis has been replaced by `metadata`.\n","deprecated":true,"type":"object","properties":{"cardMetadata":{"description":"If a card payment instrument is used then BR-DGE may be able to provide metadata about the card\n\n**Please note: All text will be UPPERCASE and all fields can be null** DEPRECATED: If this field exists, instead `metadata` should be used.\n","deprecated":true,"allOf":[{"$ref":"#/components/schemas/CardMetadata"}]}}},"PaymentStatusPaymentInstrumentPayPal":{"allOf":[{"$ref":"#/components/schemas/BasePaymentStatusPaymentInstrument"},{"type":"object","properties":{"account":{"$ref":"#/components/schemas/PaymentInstrumentAccountBase"}}}]},"PaymentStatusPaymentInstrumentIdeal":{"allOf":[{"$ref":"#/components/schemas/BasePaymentStatusPaymentInstrument"},{"type":"object"}]},"PaymentInstrumentAccountBase":{"title":"Account","type":"object","properties":{"accountId":{"type":"string","description":"The unique account identifier used by the payment instrument provider (Skrill, Paypal etc.) The id is only available after the customer has logged in to their account. Only supported on a subset of payment instruments.\n","example":"customer@email.com"}}},"TrueLayerUserData":{"description":"Contains TrueLayer customer account information.\n","type":"object","properties":{"title":{"type":"string","description":"Title of the customer.","example":"Mr"},"firstName":{"type":"string","description":"First name of the customer.","example":"John"},"lastName":{"type":"string","description":"Last name of the customer.","example":"Smith"},"dateOfBirth":{"$ref":"#/components/schemas/DateOfBirth"},"address":{"$ref":"#/components/schemas/Address"},"accountDetails":{"$ref":"#/components/schemas/TrueLayerAccountDetails"}}},"TrueLayerAccountDetails":{"description":"TrueLayer Account Details","type":"object","properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"sortCode":{"$ref":"#/components/schemas/SortCode"},"iban":{"$ref":"#/components/schemas/Iban"},"providerId":{"type":"string","description":"The TrueLayer ID of a bank or other financial institution.","example":"gb-monzo"},"paymentSourceId":{"description":"The TrueLayer ID of the customer's payment details.","type":"string","example":"ff411383-f513-4b08-b012-69815bd80568"}}},"PaymentStatusPaymentInstrumentBancontact":{"allOf":[{"$ref":"#/components/schemas/BasePaymentStatusPaymentInstrument"},{"type":"object"}]},"PaymentStatusPaymentInstrumentTrustly":{"allOf":[{"$ref":"#/components/schemas/BasePaymentStatusPaymentInstrument"},{"type":"object","properties":{"account":{"allOf":[{"$ref":"#/components/schemas/TrustlyAccount"},{"required":["accountId"]}]}}}]},"PayoutStatusPaymentInstrumentTrustly":{"allOf":[{"$ref":"#/components/schemas/BasePaymentStatusPaymentInstrument"},{"type":"object","properties":{"account":{"$ref":"#/components/schemas/PaymentInstrumentAccountBase"}}}]},"PaymentStatusPaymentInstrumentPix":{"allOf":[{"$ref":"#/components/schemas/BasePaymentStatusPaymentInstrument"},{"type":"object"}]},"PaymentStatusPaymentInstrumentPspTokenInstrument":{"allOf":[{"$ref":"#/components/schemas/BasePaymentStatusPaymentInstrument"},{"type":"object","properties":{"token":{"description":"The PSP Token used to initiate payment/payout","type":"string"},"customerId":{"description":"The customerId used when provisioning PSP Token.\nThis is only needed with certain PSP tokens.\n","type":"string"}}}]},"PaymentInstrumentPspTokenInstrument":{"allOf":[{"$ref":"#/components/schemas/BasePaymentStatusPaymentInstrument"},{"type":"object"}]},"PaymentStatusPaymentInstrumentAstroPayInstrument":{"allOf":[{"$ref":"#/components/schemas/BasePaymentStatusPaymentInstrument"},{"type":"object"}]},"PaymentStatusPaymentInstrumentPaysafecard":{"allOf":[{"$ref":"#/components/schemas/BasePaymentStatusPaymentInstrument"},{"type":"object","properties":{"account":{"$ref":"#/components/schemas/PaymentInstrumentAccountBase"}}}]},"PayoutStatusPaymentInstrumentPayPal":{"allOf":[{"$ref":"#/components/schemas/BasePaymentStatusPaymentInstrument"},{"type":"object","properties":{"payPalAccountId":{"$ref":"#/components/schemas/PayPalAccountId"}}}]},"PaymentStatusPaymentInstrumentNeteller":{"allOf":[{"$ref":"#/components/schemas/BasePaymentStatusPaymentInstrument"},{"type":"object","properties":{"account":{"$ref":"#/components/schemas/PaymentInstrumentAccountBase"}}}]},"PaymentStatusPaymentInstrumentEasyPay":{"allOf":[{"$ref":"#/components/schemas/BasePaymentStatusPaymentInstrument"},{"type":"object"}]},"PaymentStatusPaymentInstrumentEPay":{"allOf":[{"$ref":"#/components/schemas/BasePaymentStatusPaymentInstrument"},{"type":"object"}]},"PaymentStatusPaymentInstrumentSkrill":{"allOf":[{"$ref":"#/components/schemas/BasePaymentStatusPaymentInstrument"},{"type":"object","properties":{"account":{"$ref":"#/components/schemas/PaymentInstrumentAccountBase"}}}]},"PaymentStatusPaymentInstrumentSkrillOneTap":{"allOf":[{"$ref":"#/components/schemas/BasePaymentStatusPaymentInstrument"},{"type":"object"},{"required":["oneTapPaymentId"],"properties":{"oneTapPaymentId":{"type":"string","description":"BR-DGE paymentId for the order where 1-Tap payment was initially set up.","example":"123e4567-e89b-12d3-a456-426614174000"}}}]},"PaymentStatusPaymentInstrumentRevolutPay":{"allOf":[{"$ref":"#/components/schemas/BasePaymentStatusPaymentInstrument"},{"type":"object"}]},"PaymentStatusPaymentInstrumentTrueLayer":{"allOf":[{"$ref":"#/components/schemas/BasePaymentStatusPaymentInstrument"},{"type":"object","properties":{"userData":{"$ref":"#/components/schemas/TrueLayerUserData"}}}]},"PaymentStatusPaymentInstrumentOneVoucher":{"allOf":[{"$ref":"#/components/schemas/BasePaymentStatusPaymentInstrument"},{"type":"object"}]},"PaymentStatusPaymentInstrumentBluVoucher":{"allOf":[{"$ref":"#/components/schemas/BasePaymentStatusPaymentInstrument"},{"type":"object"}]},"PaymentStatusPaymentInstrumentBank2Bank":{"allOf":[{"$ref":"#/components/schemas/BasePaymentStatusPaymentInstrument"},{"type":"object"}]},"PaymentStatusPaymentInstrumentOttVoucher":{"allOf":[{"$ref":"#/components/schemas/BasePaymentStatusPaymentInstrument"},{"type":"object"}]},"PayoutStatusPaymentInstrumentTrueLayer":{"allOf":[{"$ref":"#/components/schemas/BasePaymentStatusPaymentInstrument"},{"type":"object"}]},"PayoutStatusPaymentInstrumentAccessWorldpayBankPayout":{"allOf":[{"$ref":"#/components/schemas/BasePaymentStatusPaymentInstrument"},{"type":"object"}]},"PayoutStatusPaymentInstrumentOtt":{"allOf":[{"$ref":"#/components/schemas/BasePaymentStatusPaymentInstrument"},{"type":"object"}]},"ComcardeCode":{"title":"ComcardeCode","deprecated":true,"type":"object","properties":{"code":{"description":"A unique identifier covering the outcome of the request.","type":"string","example":"1000"},"description":{"description":"A description of the outcome of the request.","type":"string"}}},"RiskAssessments":{"description":"An optional map of risk assessment results received from risk engines.","type":"object","properties":{"kount":{"$ref":"#/components/schemas/KountRiskAssessment"},"merchant":{"$ref":"#/components/schemas/MerchantRiskAssessment"}}},"PayoutRiskAssessments":{"description":"An optional map of risk assessment results received from risk engines.","type":"object","properties":{"merchant":{"$ref":"#/components/schemas/MerchantRiskAssessment"}}},"PayPalOrderRiskAssessments":{"description":"An optional map of risk assessment results received from risk engines.","type":"object","properties":{"merchant":{"$ref":"#/components/schemas/MerchantRiskAssessment"}}},"KountRiskAssessment":{"description":"Risk assessment from Kount risk engine.","type":"object","required":["decision"],"properties":{"score":{"description":"The [Omniscore] transaction safety rating received from Kount's risk engine.\n\n[Omniscore]: https://support.kount.com/hc/en-us/articles/360045236712-Omniscore-Overview\n","type":"number","format":"double","example":85.5},"decision":{"description":"Kount's risk decision\n\nCan be one of:\n- `APPROVED`: Kount risk engine has approved the transaction.\n- `DECLINED`: Kount risk engine has declined the transaction.\n- `UNAVAILABLE`: Kount risk engine was unavailable to give a decision.\n- `REVIEW`: Kount risk engine has advised that manual review of transaction is required.\n","type":"string","enum":["APPROVED","DECLINED","UNAVAILABLE","REVIEW"],"example":"APPROVED"},"reasonCode":{"description":"The **reasonCode** indicates a [Custom Reason Code] you've configured within your Kount dashboard. This code is returned when a specific individual rule you've created in Kount is triggered.\n\nTo manage or add new custom reason codes and their associated rules, please use your Kount dashboard.\n\n[Custom Reason Code]: https://support.kount.com/hc/en-us/articles/360045746411-Set-Up-Custom-Reason-Codes\n","type":"string","example":"APPROVED_3DS_STEP_UP"},"transactionId":{"description":"Transaction identifier provided by Kount.","type":"string"},"tags":{"description":"List of tags assigned to the transaction by Kount.","type":"array","nullable":true,"items":{"type":"string"},"example":["3DS_CHALLENGE","NEW_DEVICE"]}}},"MerchantRiskAssessment":{"description":"Risk assessment from Merchant's own risk engine. Can be used to return results when\nthe merchant has a proprietary risk or validation engine they wish to call during the\npayment or payout flows.\n","type":"object","required":["decision"],"properties":{"decision":{"description":"Merchant's decision\n\nCan be one of:\n- `APPROVED`: Merchant's risk engine has approved the transaction.\n- `DECLINED`: Merchant's risk engine has declined the transaction.\n- `UNAVAILABLE`: Merchant's risk engine was unavailable to give a decision.\n- `HELD`: Merchant’s risk engine has placed the transaction on hold\n","type":"string","enum":["APPROVED","DECLINED","UNAVAILABLE","HELD"],"example":"APPROVED"},"code":{"description":"The response code returned by the engine.","type":"string"},"message":{"description":"Message returned by the engine.","type":"string"},"retryable":{"description":"Indicates whether transaction can be amended and retried.","type":"boolean","example":true},"transactionId":{"description":"Transaction identifier returned by the Merchant risk engine.","type":"string"},"rawResponse":{"$ref":"#/components/schemas/RawResponse"}}},"RiskInstruments":{"type":"object","description":"Map of optional risk instrument objects which can be used to pass risk information to PSPs or risk engines\n","properties":{"checkoutRiskJs":{"$ref":"#/components/schemas/CheckoutRiskJs"},"kount":{"$ref":"#/components/schemas/Kount"},"merchant":{"$ref":"#/components/schemas/Merchant"}}},"PayoutRiskInstruments":{"type":"object","description":"Map of optional risk instrument objects which can be used to pass risk information to PSPs or risk engines\n","properties":{"merchant":{"$ref":"#/components/schemas/Merchant"}}},"Card":{"title":"Card","description":"A type of [Payment Instrument] representing a credit or debit payment card.\n\n[Payment Instrument]: https://docs.br-dge.io/docs/introduction#payment-instrument\n","type":"object","required":["expiryDate","pan","type"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `PaymentInstrument` schema."},"nameOnCard":{"maxLength":45,"minLength":2,"type":"string","description":"Name on the credit or debit card\nPlease use only letters, numbers, spaces and these symbols: -'.","example":"John F Doe"},"pan":{"type":"string","maxLength":19,"minLength":14,"description":"PAN of the credit or debit card.","example":"4444 3333 2222 1111"},"expiryDate":{"$ref":"#/components/schemas/CardExpiryDate"},"startDate":{"type":"string","description":"Start date of the credit or debit card.","example":"01-00"},"issueNumber":{"maximum":9,"minimum":1,"type":"integer","description":"Issue number of the credit or debit card.","format":"int32","example":1},"cv2":{"maximum":4,"minimum":3,"pattern":"^[0-9]*$","type":"string","description":"CV2 of the credit or debit card\nPlease use only numbers","example":"123"},"tokenize":{"type":"boolean","description":"If true, then a Card-on-File will be created.\nIf Vault interoperability is enabled on your BR-DGE Retail Channel, PSP tokens will also\nbe provisioned.","example":false},"storedCredentialIndicator":{"type":"string","description":"Indicates whether a card has been stored externally to our system,\nand if it has been used previously.\n\nUsed for the situation where you have previously used and stored the card outside\nour system.  This will override the value sent to the card networks, (e.g. Visa/Mastercard)\non the *first* time the card is used within our systems.\n\nIf your systems don't ever store card details *this field should be ignored*.\n\nWhen sent to us this affects the first time the tokenized card is used within our systems.\nIn the case of a card that you never want tokenized with us, but is tokenized externally,\nwe will require the correct value on every call.\n\nThis is related to [Credential on file mandate compliance](https://docs.br-dge.io/docs/vault#credentials-on-file-mandate-compliance).\n\n## Possible Values\n\n* FIRST - The card has not been previously used in a transaction,\n  this is used as a hint to the networks that the card will be stored from\n  this point onward.\n* SUBSEQUENT - The card has been previously used in a transaction on your systems,\n  this lets the networks know that this is a previously stored card.\n\n*Usage Notes:*\n\n* Not sending a value for this implies that you have not stored the card for reuse\n  within your systems.\n* If your company never stores cards for reuse then there is no need to ever send\n  a value for this field.\n* This field is optional but *MUST* be filled when using a previously/externally stored card.\n","enum":["FIRST","SUBSEQUENT"]}}},"PayoutCard":{"title":"Card","description":"A type of [Payment Instrument] representing a credit or debit card used for Payouts.\n\n[Payment Instrument]: https://docs.br-dge.io/docs/introduction#payment-instrument\n","type":"object","required":["pan","type","expiryDate"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `PaymentInstrument` schema."},"nameOnCard":{"maxLength":45,"minLength":2,"type":"string","description":"Name on the credit or debit card\nPlease use only letters, numbers, spaces and these symbols: -'.","example":"John F Doe"},"pan":{"type":"string","maxLength":19,"minLength":14,"description":"PAN of the credit or debit card.","example":"4444 3333 2222 1111"},"expiryDate":{"$ref":"#/components/schemas/CardExpiryDate"}}},"PayPalPayout":{"title":"PayPal","description":"A type of [Payment Instrument] representing a PayPal account used for Payouts. Please supply only one of: payPalAccountId, recipient.phoneNumber, or recipient.email. The chosen field will be used to identify the recipient of the PayPal payout.\n[Payment Instrument]: https://docs.br-dge.io/docs/introduction#payment-instrument\n","type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `PaymentInstrument` schema."},"payPalAccountId":{"$ref":"#/components/schemas/PayPalAccountId"}}},"CheckoutRiskJs":{"description":"Risk instrument for Checkout's Risk.js product. Checkout's risk engine will also use the customer's IP address if available which can be provided via Payment.customerIpAddress\n","type":"object","required":["deviceSessionId"],"properties":{"deviceSessionId":{"type":"string","description":"device_session_id token generated in Checkout's Risk.js package"}}},"GooglePay":{"title":"Google Pay","description":"A type of [Payment Instrument].\n\nFor more information please refer to the [Google Pay Feature] page.\n\n[Payment Instrument]: https://docs.br-dge.io/docs/introduction#payment-instrument\n[Google Pay Feature]: https://docs.br-dge.io/docs/features-google-pay\n","type":"object","required":["nonce","type"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `PaymentInstrument` schema."},"nonce":{"$ref":"#/components/schemas/GooglePayToken"}}},"Kount":{"description":"Risk instrument for Kount risk engine\n","type":"object","required":["sessionId"],"properties":{"sessionId":{"type":"string","description":"[Session ID] used in Kount's [Device Data Collector]\n\n[Session ID]: https://developer.kount.com/hc/en-us/sections/5319287642260-Integration-Guide?article=4411121644820\n[Device Data Collector]: https://developer.kount.com/hc/en-us/sections/5319287642260-Integration-Guide?article=4411121101844\n"}}},"Merchant":{"description":"Risk instrument for Merchant risk engine\n","type":"object","additionalProperties":{"type":"string","minLength":1,"maxLength":200,"nullable":false,"maxProperties":25,"description":"A map that contains key/value pairs representing data needed to call the Merchant risk engine\n\nUp to 25 fields can be included with the following constraints:\n\nThe field name may not be empty or have leading or trailing whitespace, and can consist of upper and lowercase letters, numbers, space, underscore \"_\", hyphen \"-\" and single quote \"'\".\n\nMaximum string length of field name and of field value is 200 chars.\n\nFor more information contact [Customer Support]\n\n[Customer Support]: https://docs.br-dge.io/docs/support#contact-support\n"}},"MerchantInitiatedDetails":{"title":"Merchant Initiated Details","description":"If the transaction is the first payment within a series of merchant initiated transactions then `initialPayment` should be set to `true` and `previousPaymentId` should be omitted. The paymentId that is returned can then be used to make subsequent transactions, which are not cardholder initiated.\n\nWhen performing a payment that is a subsequent payment, then `initialPayment` should be set to `false` or ommited, and `previousPaymentId` should be set to the returned `paymentId` of the initial payment.\n\nThis field should be used in conjunction with the `merchantInitiated` field.\n","properties":{"initialPayment":{"type":"boolean","default":false,"description":"`true` If this is the first transaction within a series of MIT transactions (a CIT transaction)\n"},"previousPaymentId":{"type":"string","description":"When the transaction is a subsequent payment, `previousPaymentId` should be set to the `paymentId` returned in the initial payment.\nIf `initialPayment` is set to `true`, then this field *must* be omitted.\n"}}},"PaymentInstrument":{"oneOf":[{"$ref":"#/components/schemas/ApplePay"},{"$ref":"#/components/schemas/AstroPay"},{"$ref":"#/components/schemas/Bancontact"},{"$ref":"#/components/schemas/Bank2BankPayment"},{"$ref":"#/components/schemas/BluVoucher"},{"$ref":"#/components/schemas/Card"},{"$ref":"#/components/schemas/ClickToPay"},{"$ref":"#/components/schemas/EasyPayPayment"},{"$ref":"#/components/schemas/EPayPayment"},{"$ref":"#/components/schemas/GooglePay"},{"$ref":"#/components/schemas/Ideal"},{"$ref":"#/components/schemas/NetellerPayment"},{"$ref":"#/components/schemas/OneVoucher"},{"$ref":"#/components/schemas/OttVoucher"},{"$ref":"#/components/schemas/PayPal"},{"$ref":"#/components/schemas/PaysafecardPayment"},{"$ref":"#/components/schemas/Pix"},{"$ref":"#/components/schemas/ProviderThreeDSecureNonce"},{"$ref":"#/components/schemas/PspTokenInstrument"},{"$ref":"#/components/schemas/RevolutPayPayment"},{"$ref":"#/components/schemas/Tokenized"},{"$ref":"#/components/schemas/TrustlyPayment"},{"$ref":"#/components/schemas/SkrillPayment"},{"$ref":"#/components/schemas/SkrillOneTapPayment"},{"$ref":"#/components/schemas/TrueLayerPayment"}],"discriminator":{"propertyName":"type","mapping":{"applePay":"#/components/schemas/ApplePay","astroPay":"#/components/schemas/AstroPay","bancontact":"#/components/schemas/Bancontact","bank2bank":"#/components/schemas/Bank2BankPayment","bluVoucher":"#/components/schemas/BluVoucher","card":"#/components/schemas/Card","clickToPay":"#/components/schemas/ClickToPay","easyPay":"#/components/schemas/EasyPayPayment","ePay":"#/components/schemas/EPayPayment","googlePay":"#/components/schemas/GooglePay","ideal":"#/components/schemas/Ideal","neteller":"#/components/schemas/NetellerPayment","oneVoucher":"#/components/schemas/OneVoucher","ottVoucher":"#/components/schemas/OttVoucher","payPal":"#/components/schemas/PayPal","paysafecard":"#/components/schemas/PaysafecardPayment","pix":"#/components/schemas/Pix","providerThreeDSecureNonce":"#/components/schemas/ProviderThreeDSecureNonce","pspToken":"#/components/schemas/PspTokenInstrument","revolutPay":"#/components/schemas/RevolutPayPayment","skrill":"#/components/schemas/SkrillPayment","skrillOneTapPayment":"#/components/schemas/SkrillOneTapPayment","tokenized":"#/components/schemas/Tokenized","trueLayer":"#/components/schemas/TrueLayerPayment","trustly":"#/components/schemas/TrustlyPayment"}}},"Action":{"title":"Action","description":"An object that contains information required to perform an action after the response is received","type":"object","properties":{"type":{"type":"string","description":"Value indicating the type of this post-response action.","example":"3D_SECURE"},"paymentId":{"type":"string","description":"The ID of the payment that this post-response action relates to.","example":"57f7f444-29ce-4230-8c7f-1c1fd85c8bc9"},"data":{"type":"object","additionalProperties":{"type":"string"},"description":"A map that contains key/value pairs representing data needed to process this post-response action.\n"}}},"ApplePay":{"title":"Apple Pay","description":"A type of [Payment Instrument]. Apple Pay is a digital Wallet that offers your customers a simple, secure, and private way to pay within your iOS and watchOS apps, and on your websites via Safari. For more information please refer to the BR-DGE [Apple Pay feature guide].\n\n[Payment Instrument]: https://docs.br-dge.io/docs/introduction#payment-instrument\n[Apple Pay feature guide]: https://docs.br-dge.io/docs/features-apple-pay\n","type":"object","required":["nonce","type"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `PaymentInstrument` schema."},"nonce":{"$ref":"#/components/schemas/ApplePayToken"}}},"ApplePayToken":{"description":"If you are directly integrating with Apple Pay APIs on your client app then please refer to our [Apple Pay REST API guide] for details on how to generate an Apple Pay token for BR-DGE Payments.\n\nAlternatively you can use the [BR-DGE Web SDK Apple Pay module] to directly generate Apple Pay tokens for BR-DGE Payments.\n\n[Apple Pay REST API guide]: https://docs.br-dge.io/docs/rest-api-apple-pay\n[BR-DGE Web SDK Apple Pay module]: https://docs.br-dge.io/docs/apple-pay-module\n","type":"string","minLength":0,"example":"BR#00000000-0000-0000-0000-000000000000"},"AstroPay":{"title":"AstroPay","description":"A type of [Payment Instrument].\n\nPlease note: `documentId`, `documentType`, `customerFirstName`, and `customerLastName` are also required for AstroPay payments if you are a merchant operating in the Gaming industry in Brazil. In this case 'CPF' is the only accepted document type. If you are unsure whether you need to supply this data, please raise a ticket with support on the BR-DGE Support Portal at <https://docs.br-dge.io/docs/support#contact-support>.\n\n[Payment Instrument]: https://docs.br-dge.io/docs/introduction#payment-instrument\n","type":"object","required":["type","redirectUrl","productCode","productDescription"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `PaymentInstrument` schema."},"redirectUrl":{"type":"string","maxLength":300,"example":"https://myurl.com/f219ea52-d91f-4059-a560-8dd7cbd31fd0","description":"URL that your customer's browser will be redirected to after completing the transaction.\n\nBy using unpredictable single-use URLs you can protect yourself from the possibility of bad actors attempting to make it appear that payments had a different outcome to reality. We also recommend that you confirm the outcome of payments via server-to-server calls to BR-DGE.\n"},"userId":{"type":"string","maxLength":64,"description":"The customer's AstroPay User ID. If it's included in the request only that user will be able to complete the payment. The User ID is only assigned after a successful request, where it can then be found when confirming the outcome of the payment via our [Payment Status endpoint] or via BR-DGE callback.\n\n[Payment Status endpoint]: https://docs.br-dge.io/reference/getpaymentstatususingget\n","example":"Vx0H4pdAtPCz"},"productCode":{"type":"string","maxLength":32,"description":"Merchant's unique identifier for the product being purchased.\n","example":"123456"},"productDescription":{"type":"string","maxLength":128,"description":"Description of the product being purchased.\n","example":"My product description"}}},"Bancontact":{"title":"Bancontact","description":"A type of [Payment Instrument].\n\nPlease note: `currencyCode` must be `EUR` and `billingAddress.country` must be `BE`.\n\n[Payment Instrument]: https://docs.br-dge.io/docs/introduction#payment-instrument\n","type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `PaymentInstrument` schema."},"successUrl":{"type":"string","maxLength":300,"minLength":2,"description":"A url that is invoked after a successful Bancontact payment.","example":"https://myurl.com/success"},"errorUrl":{"type":"string","maxLength":300,"minLength":2,"description":"A url that is invoked after an unsuccessful Bancontact payment.","example":"https://myurl.com/error"}}},"ClickToPay":{"title":"Click-to-Pay","type":"object","description":"A type of [Payment Instrument]. Click-to-Pay, also called Unified Click-to-Pay or Unified Checkout, is a multi-network digital wallet solution provided by VISA Acceptance.\n[Payment Instrument]: https://docs.br-dge.io/docs/introduction#payment-instrument\n","required":["nonce","type"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `PaymentInstrument` schema.","example":"clickToPay"},"nonce":{"$ref":"#/components/schemas/ClickToPayToken"}}},"ClickToPayToken":{"description":"Upon calling the Click-to-Pay's `checkout()` method, a JSON Web Token (JWT) is returned. Decoding this provides a secondary `uctpResponse.payload` JWT value.\nThis `payload` should be provided to BR-DGE via the `/v1/payment-instruments/single-use` endpoint, with the resulting BR-DGE single-use token provided to this field.\n","type":"string","minLength":0,"example":"94ec2d98-d2c9-422c-95e2-b6c4c8400968","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"GooglePayToken":{"description":"## If you integrate directly with the Google Pay&trade; API\nFollow the procedure in the Google Pay documentation to integrate your [web](https://developers.google.com/pay/api/web/guides/setup) or [Android](https://developers.google.com/pay/api/android/guides/setup) application.\nIn the step where you choose a payment tokenization method, choose `Gateway`, then set `comcarde` as your `gateway`. If you have not been provided with a `gatewayMerchantId` parameter, please raise a ticket with support on the BR-DGE Support Portal at <https://docs.br-dge.io/docs/support#contact-support>.\n## If you use a BR-DGE SDK\nThe BR-DGE SDK can optionally be used to automate client side interactions with the Google Pay&trade; API. The SDK will output a nonce that you can directly use.\nFor more information please refer to the [Google Pay Feature](https://docs.br-dge.io/docs/features-google-pay) page.\n","type":"string","minLength":0,"example":"{\"apiVersion\":2,\"apiVersionMinor\":0, \"paymentMethodData\":{\"description\": \"Test Card: Visa •••• 1111\", \"info\":{\"assuranceDetails\":{\"accountVerified\":true, \"cardHolderAuthenticated\":false},\"cardDetails\":\"1111\", \"cardNetwork\":\"VISA\"},\"tokenizationData\":{\"token\": \"{\"signature\":\"MEUCIBSc1HRfQds/JkpNXakkaJf2geKR9HZE4Rhof/ qnNRymAiEArDzEmaOC+lTqzHmvA+Z1sFfRMROdtr0pTAGVFWUjLV4u003d\", \"intermediateSigningKey\":{\"signedKey\":\"{\"keyValue\": \"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE60Dnzr+/JD +xJOOIFBMRyVoqPCbQcBjj/TwGJu9ct/srT8tZDDWJzNZo2vDE50YLE38oHBJWLjAws hqDzKfQKQu003du003d\",\"keyExpiration \":\"1710831722061\"}\",\"signatures\":[\"M EUCIQDqib3bqGDAzyQRRtc7xci1EzhNqxAj1oEIrCfSiUd7WAIgc09CIVz7zKa9StsZ Bw95vvoRORsbF1qCKtPk5ltQihEu003d\"]},\"protocolVersion\": \"ECv2\",\"signedMessage\":\"{\"encryptedMessage \":\"My/Y7NLgWNCMiQzd/muw8XyCMDhMS38j9FjTyKPsmKNWM5UHl+PkT urYyVv6kSJGAkWF6HCBIx3J1Ch6kJtx4w8/pmP7ujxCwEiDiynsffAIeubQpkv69gIp +H/SZs7DiqOvdhXhHF5vpkYvU3NmVMjvNZeU3rgclwldC1IAJzGyxdafLYu7WKtajEv bBfIq/Rp+XXGkTw4pkGt7MYVNcWqUY4qO1mRmIyyj+UrR5wru9rXlxZu9xA0ofdBc4a 8tkOp6wUgD+5+VMZ3GbUrQZbV+hnwFqMl60U1+u2nSr9PInbusVT73tqr2Y37EmViCC I1s0Evoj8nakWgblLQ9L0HMS2G9XdIvktuLS2oDDxZziv1IquBShyYeik0Hhceq5HK9 d16MTIpLm1kP188YL1TtHoVCRNJX0T5lTfsTATN9PsMp9fl+SRBzjr2ZrfFtyjJB652 wi6FMJquIcVIoc1t6HAJ6ZQQyaR8gWaV+/BmkIm6EPmOUczF5sYTNGXilnKf91PwaoN zhBnatlx468fqkvyKGN5pjfsK2BCUGJJw9UwiYPWNrD24fzJ/Fwlxh0uToo5CiT8KmA qoKSxzJ9Fh/XtVsbbH0+yfUBNUfLsWs3Rsu003d\",\"eph emeralPublicKey\":\"BLyIO17wMMcKccD9XJMlUQ8vHnI3IfoE6Ss bQuVxerTtolZ7ICGRhW0lbxF3q7blzvgSDIYLk9cab27mCKT0sy0u003d \",\"tag\":\"CIKT0sRruAuW7nJ3THAgZuWHpE0PJBc4 eLmfHRWZgpsu003d\"}\"}\", \"type\":\"PAYMENT_GATEWAY\"},\"type\":\"CARD\"}}"},"Ideal":{"title":"iDEAL","description":"A type of [Payment Instrument].\n\nPlease note: `currencyCode` must be `EUR` and `billingAddress.country` must be `NL`.\n\n[Payment Instrument]: https://docs.br-dge.io/docs/introduction#payment-instrument\n","type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `PaymentInstrument` schema."},"successUrl":{"type":"string","maxLength":300,"minLength":2,"example":"https://myurl.com/success/f219ea52-d91f-4059-a560-8dd7cbd31fd0","description":"URL that your customer's browser will be redirected to after they successfully authorize a payment via iDEAL.\n\nBy using unpredictable single-use URLs you can protect yourself from the possibility of bad actors attempting to make it appear that payments had a different outcome to reality. We also recommend that you confirm the outcome of payments via server-to-server calls to BR-DGE.\n"},"errorUrl":{"type":"string","maxLength":300,"minLength":2,"description":"A url that is invoked after an unsuccessful iDEAL payment.","example":"https://myurl.com/error"}}},"NetellerPayment":{"title":"Neteller","description":"A type of [Payment Instrument](https://docs.br-dge.io/docs/introduction#payment-instrument).\nPlease see [Paysafe](https://docs.br-dge.io/docs/paysafe-integration) for more information on this integration.\n","type":"object","required":["type","defaultUrl"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `PaymentInstrument` schema."},"defaultUrl":{"type":"string","format":"uri","description":"The default URL that a customer is redirected to after user interaction with Neteller.","example":"https://myurl.com/default"},"failedUrl":{"type":"string","format":"uri","description":"A URL that a customer is redirected to if the authorization on Neteller fails.","example":"https://myurl.com/failed"},"cancelledUrl":{"type":"string","format":"uri","description":"A URL that a customer is redirected to if the Neteller request is cancelled.","example":"https://myurl.com/cancelled"}}},"OneVoucher":{"title":"1Voucher","description":"A type of [Payment Instrument]\n\nPlease note: `currencyCode` must be `ZAR` and `amount` must be `0`.\n\n[Payment Instrument]: https://docs.br-dge.io/docs/introduction#payment-instrument\n","type":"object","required":["pin","type"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `PaymentInstrument` schema."},"pin":{"type":"string","description":"The 16 digit PIN from the Voucher","maxLength":16,"minLength":16,"pattern":"^[0-9]*$","example":"1234567890123456"}}},"OttVoucher":{"title":"OTT Voucher","description":"A type of [Payment Instrument]\n\nPlease note: `currencyCode` must be `ZAR`.\n\n[Payment Instrument]: https://docs.br-dge.io/docs/introduction#payment-instrument\n","type":"object","required":["type","pin","mobile"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `PaymentInstrument` schema."},"pin":{"type":"string","description":"The voucher PIN","maxLength":25,"pattern":"^[0-9]*$","example":"720686941917"},"mobile":{"$ref":"#/components/schemas/PhoneNumber"}}},"BluVoucher":{"description":"A type of [Payment Instrument]\n\nPlease note: `currencyCode` must be `ZAR`.\n\n[Payment Instrument]: https://docs.br-dge.io/docs/introduction#payment-instrument\n","type":"object","required":["type","pin"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `PaymentInstrument` schema."},"pin":{"type":"string","description":"The voucher PIN","minLength":9,"maxLength":16,"pattern":"^[0-9]+$","example":"720686941917"}}},"PayPal":{"title":"PayPal","description":"A type of [Payment Instrument]\n\n[Payment Instrument]: https://docs.br-dge.io/docs/introduction#payment-instrument\n","type":"object","required":["nonce","type"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `PaymentInstrument` schema."},"nonce":{"maxLength":255,"minLength":1,"type":"string","description":"Nonce value that represents the details of the PayPal payment.","example":"BR#00000000-0000-0000-0000-000000000000"}}},"PaysafecardPayment":{"title":"Paysafecard","description":"A type of [Payment Instrument](https://docs.br-dge.io/docs/introduction#payment-instrument).\nPlease see [Paysafecard](https://docs.br-dge.io/docs/paysafecard-integration) for more information on this integration.\n","type":"object","required":["type","successUrl","errorUrl"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `PaymentInstrument` schema."},"successUrl":{"type":"string","description":"A url that a customer is redirected to after successful or failed authorization on Paysafecard.","example":"https://myurl.com/success"},"errorUrl":{"type":"string","description":"A url that a customer is redirected to after customer cancels the payment on Paysafecard","example":"https://myurl.com/error"},"countryRestriction":{"type":"string","pattern":"^[A-Za-z]{2}$","description":"ISO 3166-1 alpha-2 two-letter country code used to restrict payments to residents of a particular country.","example":"GB"},"kycLevel":{"type":"string","description":"The Know Your Customer (KYC) level of the customer's myPaysafe account. Depending on the country, myPaysafe accounts are offered with SIMPLE and/or FULL customer identification.\n","enum":["SIMPLE","FULL"]},"minAge":{"type":"integer","description":"Restricts payments to myPaysafe customers only, who are equal to or older than the specified age. Please note, this means that it is required that the customer has a registered myPaysafe account to make the payment.\n","example":18},"submerchantId":{"type":"string","maxLength":8,"description":"ID used to classify sub-merchants. Values must be agreed with Paysafecard, non-agreed values will lead to a failed payment.\n"}}},"Pix":{"title":"Pix","description":"A type of [Payment Instrument](https://docs.br-dge.io/docs/introduction#payment-instrument).\nPix is an instant payment system created and managed by the Central Bank of Brazil.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `PaymentInstrument` schema."},"successUrl":{"type":"string","maxLength":300,"minLength":2,"example":"https://myurl.com/success/f219ea52-d91f-4059-a560-8dd7cbd31fd0","description":"A URL that is invoked after a successful Pix payment.\nBy using unpredictable single-use URLs you can protect yourself from the possibility of bad actors attempting to make it appear that payments had a different outcome to reality. We also recommend that you confirm the outcome of payments via server-to-server calls to BR-DGE.\n"},"errorUrl":{"type":"string","maxLength":300,"minLength":2,"description":"A URL that is invoked after an unsuccessful Pix payment.","example":"https://myurl.com/error"}}},"ProviderThreeDSecureNonce":{"description":"A type of [Payment Instrument].\nPart of the [3-D Secure Payment Flow]. In the event that you get a 3-D Secure additional action required response to a payment request, you can use the [BR-DGE Web SDK Post Response Module] to handle the action and convert it into a nonce you can use to complete the payment with a `ProviderThreeDSecureNonce` [Payment Instrument].\n\n[BR-DGE Web SDK Post Response Module]: https://docs.br-dge.io/docs/post-response-module\n[Payment Instrument]: https://docs.br-dge.io/docs/introduction#payment-instrument\n[3-D Secure Payment Flow]: https://docs.br-dge.io/docs/payment-flows#3-d-secure-payment-flow\n","type":"object","required":["nonce","paymentId","type"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `PaymentInstrument` schema."},"paymentId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"Payment ID of the payment","example":"00000000-0000-0000-0000-000000000000"},"nonce":{"maxLength":255,"minLength":0,"type":"string","pattern":"^([A-Z0-9_]{2,25})(#)([a-zA-Z0-9\\-'.]+)$","description":"Nonce value that represents the details of the payment along with its 3-D Secure authentication outcome","example":"BR#00000000-0000-0000-0000-000000000000"}}},"TrustlyAccountId":{"type":"string","description":"This is Trustly's bank account identifier, used to enable [Trustly Express flow] transactions. Providing the `accountId` streamlines transactions for returning customers, allowing them to bypass steps and complete transactions faster, which enhances customer loyalty and increases conversion rates.\n\nThe `accountId` can be obtained from:\n- Payment Instrument Account Selection BR-DGE callback\n- `GET /v1/payments` response\n- `GET /v1/payments/{paymentId}/status` response\nNote: Ensure the `customerId` matches the customer ID from the previous transaction associated with this `accountId`.\n\n[Trustly Express flow]: https://eu.developers.trustly.com/doc/reference/trustly-express-overview\n","maxLength":100,"example":"1234567890"},"TrustlyBase":{"type":"object","title":"Trustly","required":["type","successUrl","errorUrl"],"description":"Trustly is an Open Banking [Payment Instrument].\n\nWhen using this instrument type for a payment, you must provide a customer ID in the `payment.customerId` field. This field is used within Trustly back office to help merchants keep track of the transaction.\n\nFor more information, please see our [Trustly User Guide].\n\n[Trustly User Guide]: https://docs.br-dge.io/docs/trustly#/\n[Payment Instrument]: https://docs.br-dge.io/docs/introduction#payment-instrument\n","properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `PaymentInstrument` schema."},"successUrl":{"type":"string","minLength":2,"maxLength":300,"example":"https://myurl.com/success/f219ea52-d91f-4059-a560-8dd7cbd31fd0","description":"A URL that is invoked after a successful Trustly transaction.\n\nBy using unpredictable single-use URLs you can protect yourself from the possibility of bad actors attempting to make it appear that the transaction had a different outcome to reality. We also recommend that you confirm the outcome of transaction via server-to-server calls to BR-DGE.\n"},"errorUrl":{"type":"string","maxLength":300,"description":"A URL that is invoked after an unsuccessful Trustly transaction.","example":"https://myurl.com/error"}}},"TrustlyPayment":{"allOf":[{"$ref":"#/components/schemas/TrustlyBase"},{"type":"object","properties":{"accountId":{"$ref":"#/components/schemas/TrustlyAccountId"}}}]},"TrustlyPayout":{"allOf":[{"$ref":"#/components/schemas/TrustlyBase"},{"type":"object","required":["accountId"],"properties":{"accountId":{"$ref":"#/components/schemas/TrustlyAccountId"}}}]},"PspTokenInstrument":{"title":"PspTokenInstrument","description":"A type of [Payment Instrument](https://docs.br-dge.io/docs/introduction#payment-instrument) created directly with the PSP which can be used to make transactions. This payment instrument cannot be used in any payment flows which contains the card PAN (eg Kount/VISA Instalments) In the event of a BR-DGE outage, a merchant will process transactions directly with a PSP and new Card on File will be tokenized with the PSP but BR-DGE will not know about these tokens. BR-DGE will allow the merchant to process payments with these PSP tokens on the BR-DGE platform before migrating the tokenized instruments into BR-DGE.\n","type":"object","required":["token","type","psp"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `PaymentInstrument` schema."},"token":{"maxLength":200,"minLength":1,"type":"string","description":"The token that represents a payment instrument.\n","example":"00000000-0000-0000-0000-000000000000"},"psp":{"type":"string","description":"The name of the PSP which the token relates to","example":"Nuvei"},"customerId":{"maxLength":200,"minLength":1,"type":"string","description":"A unique customer ID which is required with some PSPs to create a PSP token. Must be the correct customer ID for the provided PSP token\n","example":"Customer001"},"cv2":{"maxLength":4,"minLength":3,"pattern":"[0-9]*$","type":"string","description":"CV2 of the credit or debit card the this PSP token relates to","example":"123"},"tokenType":{"$ref":"#/components/schemas/PspTokenType"}}},"Tokenized":{"title":"Tokenized","description":"A type of [Payment Instrument](https://docs.br-dge.io/docs/introduction#payment-instrument) that can be used in place of sensitive cardholder data.\n","type":"object","required":["token","type"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `PaymentInstrument` schema."},"token":{"maxLength":200,"minLength":1,"type":"string","description":"The token that represents a payment instrument.\n\nPlease use only letters, numbers, spaces and these symbols: `'[]()@?!\\-/.,_&*:;+=`.\n","example":"00000000-0000-0000-0000-000000000000"},"cv2":{"maxLength":4,"minLength":3,"pattern":"^[0-9]*$","type":"string","description":"Optional CV2 of the Tokenized payment instrument, if you haven't already provided it during the tokenization process. Please use only numbers","example":"123"},"updateStoredCredentialIndicator":{"description":"When provided this updates the indicator of whether a card has been stored externally to our system, and if it has been used previously.\n\nUsed for the situation where you have registered a card with our system, but used it externally before returning to our system to make a subsequent payment. This will override the value sent to the card networks, (e.g. Visa/Mastercard) on the *first* time the card is used within our systems.\n\nIf you do not use the card outside of the payment flow in our system before the first payment event, this feature can be ignored, as the standard used functionality will track this.\n\nThis will effectively update the payment instrument's used status before the payment transaction, as such, if an update is needed it is only required on the first payment request in our system.\n\nThis is related to [Credential on file mandate compliance].\n\n## Possible Values\n\n* USED - The card has been previously used in a transaction on your systems, this lets the networks know that this is a previously stored card.\n\n*Usage Notes:*\n\n* Not sending a value for this implies no updates are needed, and so the existing status will be used from\n  our system.\n* The update value is only needed on the first payment on our system, subsequent calls will just result in\n  extra processing.\n* This field is optional but *MUST* be filled when a card has been used outside our system before making a\n  first payment inside our system.\n* This can only be used with Card on File, and is not valid for single-use tokens.\n\n[Credential on file mandate compliance]: https://docs.br-dge.io/docs/vault#credentials-on-file-mandate-compliance\n","type":"string","enum":["USED"]}}},"SkrillPayment":{"title":"Skrill","description":"A type of [Payment Instrument](https://docs.br-dge.io/docs/introduction#payment-instrument) for Skrill, which is part of the PaySafe Limited Global Payments Platform.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `PaymentInstrument` schema."},"returnUrl":{"type":"string","format":"uri","example":"http://www.return.url","description":"URL to which the customer is returned once the payment is made. If this field is not filled, the Skrill Quick Checkout page closes automatically at the end of the transaction and the customer is returned to the page on your website from where they were redirected to Skrill."},"pendingUrl":{"type":"string","format":"uri","description":"A URL that is invoked when a Skrill payment is pending. If not provided, customer will not be re-directed should order go to pending state.","example":"https://example.com/pending"},"cancelUrl":{"type":"string","format":"uri","description":"A URL that is invoked after a cancelled Skrill payment. If not provided, cancel button does not appear for customer.","example":"https://example.com/cancel"},"paymentMethods":{"type":"array","description":"Payment methods allows specification of which payment methods should be shown to the customer. Depending Skrill account configuration, one or more can be provided. If none are provided, customer is allowed to use any payment method set up with their Skrill account of their choice.","items":{"type":"string","example":"ALI","description":"Payment methods. For OBT payments firstname, lastname, and customerEmail are mandatory. For additional information, see BR-DGE Alternative Payment Methods documentation."}},"oneTap":{"description":"Skrill 1-Tap Initialization Data if this Skrill payment is intended to initiate a 1-Tap recurring payment series. Leaving this blank will process a standard, one-time Skrill payment.","type":"object","required":["onDemandMaxAmount","note"],"properties":{"onDemandMaxAmount":{"type":"integer","maximum":999999999,"format":"int64","description":"Maximum amount for subsequent payments that will be debited from the customer’s account. In the lowest denomination of the currency of the payment.","example":1150},"note":{"type":"string","maxLength":1000,"description":"Text shown to the customer in the payment confirmation email as the reason for the Skrill 1-Tap payment.","example":"Skrill 1-Tap Payment"}}}}},"SkrillOneTapPayment":{"title":"Skrill 1-Tap","description":"A type of [Payment Instrument](https://docs.br-dge.io/docs/introduction#payment-instrument) used exclusively for subsequent Skrill 1-Tap payments.","type":"object","required":["type","oneTapPaymentId"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `PaymentInstrument` schema."},"oneTapPaymentId":{"type":"string","description":"BR-DGE paymentId for the order where 1-Tap payment was initially set up.","example":"123e4567-e89b-12d3-a456-426614174000"}}},"RevolutPayPayment":{"title":"Revolut Pay","description":"A type of [Payment Instrument](https://docs.br-dge.io/docs/introduction#payment-instrument) for Revolut Pay, an APM provided by Revolut.\nIf providing the `revolutCustomerId` the `revolutCustomerFullName` and `revolutCustomerEmail` fields will be ignored. If the `revolutCustomerId` is not known, or is a new customer, the `revolutCustomerEmail` and `revolutCustomerFullName` will be used to generate a new Revolut customer ID.\nIf `channel` is not provided, or set to `ios` or `android` then `appReturnUrl` is mandatory. If `channel` is set to `web` then `successUrl`, `failureUrl`, and `cancelUrl` are mandatory.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `PaymentInstrument` schema."},"appReturnUrl":{"type":"string","format":"uri","example":"https://myurl.com/appReturn/f219ea52-d91f-4059-a560-8dd7cbd31fd0","description":"A URL that is invoked after processing a Revolut Pay from within the Revolut app.\n"},"successUrl":{"type":"string","format":"uri","example":"https://myurl.com/success/f219ea52-d91f-4059-a560-8dd7cbd31fd0","description":"A URL that is invoked after successfully processing a Revolut Pay payment. The value takes precedence over the `appReturnUrl` when using a web browser.\n"},"failureUrl":{"type":"string","format":"uri","example":"https://myurl.com/failure/f219ea52-d91f-4059-a560-8dd7cbd31fd0","description":"A URL that is invoked after a Revolut Pay payment failure. The value takes precedence over the `appReturnUrl` when using a web browser.\n"},"cancelUrl":{"type":"string","format":"uri","example":"https://myurl.com/cancel/f219ea52-d91f-4059-a560-8dd7cbd31fd0","description":"A URL that is invoked after cancelling a Revolut Pay payment. The value takes precedence over the `appReturnUrl` when using a web browser.\n"},"revolutCustomerId":{"type":"string","format":"uuid","example":"44773429-8b07-4973-b9de-3d308e86b955","description":"Revolut customer ID"},"revolutCustomerFullName":{"type":"string","minLength":2,"example":"John Smith","description":"Revolut customer name"},"revolutCustomerEmail":{"type":"string","minLength":1,"maxLength":254,"pattern":"^$|^[a-zA-Z0-9._%'+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$","example":"john.smith@example.com","description":"Revolut customer e-mail"},"revolutPhoneNumber":{"type":"string","maxLength":50,"pattern":"^$|^[+]?[(0-9][0-9 ()-]*[0-9]$","example":"+44 123 1110000","description":"Revolut customer phone number"},"revolutFingerprint":{"$ref":"#/components/schemas/RevolutFingerprint"}}},"Bank2BankPayment":{"title":"Bank2Bank","description":"A type of [Payment Instrument](https://docs.br-dge.io/docs/introduction#payment-instrument) provided by Walletdoc.\n","type":"object","required":["type","returnUrl"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `PaymentInstrument` schema."},"returnUrl":{"type":"string","format":"uri","example":"https://myurl.com/appReturn/f219ea52-d91f-4059-a560-8dd7cbd31fd0","description":"A URL that is invoked after processing a bank2bank payment.\n"},"bankName":{"type":"string","example":"capitec","description":"The specific bank to be used for the bank2bank payment. If not specified, the user to will be routed to select the specific bank within the redirect page.\n","enum":["capitec","absa"]},"identifier":{"description":"The details used to locate the user's account.","type":"object","required":["type","value"],"properties":{"type":{"type":"string","example":"national_id","description":"The type of payment identifier used to locate the user's account.\n","enum":["national_id","passport","account","mobile_number"]},"value":{"type":"string","maxLength":255,"example":"2601010201187","description":"The value that corresponds to the `type`.\n"}}}}},"TrueLayerPayment":{"title":"TrueLayer","description":"A type of [Payment Instrument](https://docs.br-dge.io/docs/introduction#payment-instrument) for the TrueLayer Open Banking solution.\n","type":"object","required":["type","returnUrl"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `PaymentInstrument` schema."},"returnUrl":{"type":"string","format":"uri","example":"http://www.return.url","description":"URL to which the customer is returned once the payment is made."},"providerId":{"type":"string","example":"mock-payments-gb-redirect","description":"The TrueLayer ID of a bank or other financial institution that TrueLayer can initiate payments through. If not provided, the customer will be prompted to select a provider when re-directed to TrueLayer."},"signupPlus":{"type":"boolean","default":false,"description":"Boolean value indicating whether Signup+ flow is requested. If set to true, then TrueLayer will capture the user's data, and this data will be returned when you query a payment or get the status of a payment."},"verifyCustomerName":{"type":"boolean","default":false,"description":"Boolean value indicating that name verification of the customer is requested. If set to true, the name will be verified before the payment is settled. If your merchant account with TrueLayer is not enabled for verification, the payment may be rejected. Mutually exclusive with verifyCustomerAge."},"verifyCustomerAge":{"type":"boolean","default":false,"description":"Boolean value indicating that age verification of the customer is requested. If set to true, the age will be verified before the payment is settled. If your merchant account with TrueLayer is not enabled for verification, the payment may be rejected. Mutually exclusive with verifyCustomerName."},"bankDetails":{"allOf":[{"$ref":"#/components/schemas/BankDetails"}],"description":"Details of the customer's bank account that TrueLayer can initiate payments through.\nIf not provided, the customer will be prompted to select an account when re-directed to TrueLayer.\n\nRequired fields:\n  - customerFirstName\n  - customerLastName\n  - paymentInstrument.providerId\n"},"countries":{"type":"array","description":"A optional list of countries to which the available providers should be restricted. If not provided, providers from all supported countries will be shown to the customer.","items":{"$ref":"#/components/schemas/CountryIsoCode"}}}},"TrueLayerPayout":{"title":"TrueLayer","description":"TrueLayer payout. Must include one and only one of:\n  - paymentSource\n  - bankDetails\n  - verification\n","required":["type"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `PayoutPaymentInstrument` schema."},"paymentSource":{"type":"object","required":["paymentSourceId"],"description":"TrueLayer payout using a Payment Source ID. Required Fields:\n  - recipient.customerId\n","properties":{"paymentSourceId":{"type":"string","description":"Payment Source ID to make a payout with TrueLayer Open banking.\n","example":"41b500a4-5379-4f30-9eda-2fcc032afc37"}}},"bankDetails":{"allOf":[{"$ref":"#/components/schemas/BankDetails"}],"description":"Create a payout with TrueLayer using Sort Code and Account Number, or IBAN. Required fields:\n  - recipient.firstName\n  - recipient.lastName\n  - recipient.customerId\n  If the clients transactions are subject to sanctions screening, then the address must be provided,\n  otherwise it is optional. Specifically address.address1, address.town, address.postcode and address.country.\n"},"verification":{"description":"Make a TrueLayer payout which returns a redirect URL for the client to follow through. Required fields:\n  - recipient.firstName\n  - recipient.lastName\n  - recipient.customerId\n  - either recipient.email OR recipient.phoneNumber\nIf the client's transactions are subject to sanctions screening, then the address must be provided, otherwise it is optional. Specifically address.address1, address.town, address.postcode and address.country.\n","required":["verificationDetails","returnUrl"],"properties":{"verificationDetails":{"type":"object","required":["searchTokens","amount","currencyCode","paymentDate"],"properties":{"searchTokens":{"type":"array","items":{"type":"string","minLength":3,"maxLength":50,"pattern":"^[a-zA-Z0-9 .-]+$"},"minItems":1,"maxItems":5,"example":["18db38","Betropolis LTC","LC Betropolis","Midnite.com"],"description":"A list of tokens to look for as transaction reference. The size of this array can vary between 1 and 5 items. Each item should present minimum 3 and maximum 50 characters, including spaces. Alphanumeric characters, spaces, periods and hyphens are permitted.\n"},"amount":{"$ref":"#/components/schemas/Amount"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"paymentDate":{"type":"string","format":"date","description":"The date the transaction was created at","example":"2025-11-24"}}},"providerId":{"type":"string","example":"mock-payments-gb-redirect","description":"The TrueLayer ID of a bank or other financial institution that TrueLayer can initiate payments through. If not provided, the customer will be prompted to select a provider when re-directed to TrueLayer."},"returnUrl":{"type":"string","format":"uri","description":"URL to which the customer is returned once the payout is made."}}},"countries":{"type":"array","description":"An optional list of countries to which the available providers should be restricted. Only valid for `verification` payouts; a request including `countries` without `verification` will be rejected. If not provided, providers from all supported countries will be shown to the customer.","items":{"$ref":"#/components/schemas/CountryIsoCode"}}}},"BankDetails":{"type":"object","description":"Bank details of the recipient. Requires either country specific bank account details for domestic payments or IBAN details for international payments.\n","oneOf":[{"$ref":"#/components/schemas/BankAccountDetailsIBAN"},{"$ref":"#/components/schemas/BankAccountDetailsGB"}],"discriminator":{"propertyName":"bankDetailsFormat","mapping":{"IBAN":"#/components/schemas/BankAccountDetailsIBAN","GB":"#/components/schemas/BankAccountDetailsGB"}}},"BankAccountDetailsBase":{"type":"object","required":["bankDetailsFormat"],"properties":{"bankDetailsFormat":{"type":"string","description":"International or ISO 3166 Alpha-2 Country code discriminator field. The options are:\n- IBAN\n- GB\n","example":"GB","pattern":"^[A-Z]{2,4}$"}}},"BankAccountDetailsIBAN":{"allOf":[{"$ref":"#/components/schemas/BankAccountDetailsBase"},{"type":"object","properties":{"iban":{"$ref":"#/components/schemas/Iban"},"swiftBic":{"$ref":"#/components/schemas/SwiftBic"},"bankName":{"type":"string","minLength":1,"maxLength":35,"description":"Name of the bank.","example":"A Bank"}}}]},"BankAccountDetailsGB":{"allOf":[{"$ref":"#/components/schemas/BankAccountDetailsBase"},{"type":"object","properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"sortCode":{"$ref":"#/components/schemas/SortCode"},"swiftBic":{"$ref":"#/components/schemas/SwiftBic"},"bankName":{"type":"string","minLength":1,"maxLength":35,"description":"Name of the bank.","example":"A Bank"}}}]},"BankAccountDetails":{"type":"object","description":"Bank details of the recipient. Requires either country specific bank account details for domestic payments or SWIFT details for international payments.\n","oneOf":[{"$ref":"#/components/schemas/BankAccountDetailsByCountry"},{"$ref":"#/components/schemas/BankAccountDetailsByTransferType"}],"discriminator":{"propertyName":"bankDetailsFormat","mapping":{"ZA":"#/components/schemas/BankAccountDetailsByCountry","SWIFT":"#/components/schemas/BankAccountDetailsByTransferType"}}},"BankAccountBase":{"type":"object","required":["bankDetailsFormat"],"properties":{"bankDetailsFormat":{"type":"string","description":"International or South African country code discriminator field. The options are:\n- ZA\n- SWIFT\n","example":"ZA","pattern":"^[A-Z]{2,5}$"},"accountName":{"type":"string","description":"The name on the recipient's bank account.","example":"John Smith","maxLength":255}}},"BankAccountDetailsByCountry":{"allOf":[{"$ref":"#/components/schemas/BankAccountBase"},{"type":"object","properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumberZa"},"branchName":{"type":"string","maxLength":255,"description":"Name of the bank branch.","example":"Main Branch"},"branchCode":{"$ref":"#/components/schemas/SortCode"}}}]},"BankAccountDetailsByTransferType":{"allOf":[{"$ref":"#/components/schemas/BankAccountBase"},{"type":"object","properties":{"accountNumber":{"type":"string","description":"Recipient's bank account number for international transfers.","example":"1352184990","minLength":7,"pattern":"^[0-9]*$"},"swiftCode":{"$ref":"#/components/schemas/SwiftBic"}}}]},"SwiftBic":{"type":"string","minLength":8,"maxLength":11,"description":"Unique ISO 9362 Bank Identifier Code for cross-border payments.","pattern":"^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$","example":"HBUKGB4B"},"PaymentStatus":{"type":"string","description":"Status of the payment. See [Transaction Statuses](https://docs.br-dge.io/docs/transaction-statuses) for further detail.\n","example":"CAPTURED","enum":["AUTHORIZED","AUTHORIZATION_DECLINED","AUTHORIZATION_PENDING","CAPTURED","CAPTURE_FAILED","CAPTURE_PENDING","EXPIRED","REJECTED","VOIDED","VOID_PENDING","VOID_FAILED","BLOCKED","UNKNOWN"]},"PayoutStatusPaymentInstrument":{"oneOf":[{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentApplePay"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentAstroPayInstrument"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentBank2Bank"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentCard"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentClickToPay"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentEPay"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentEasyPay"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentGooglePay"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentNeteller"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentPaysafecard"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentPspTokenInstrument"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentRevolutPay"},{"$ref":"#/components/schemas/PaymentStatusPaymentInstrumentSkrill"},{"$ref":"#/components/schemas/PayoutStatusPaymentInstrumentAccessWorldpayBankPayout"},{"$ref":"#/components/schemas/PayoutStatusPaymentInstrumentOtt"},{"$ref":"#/components/schemas/PayoutStatusPaymentInstrumentPayPal"},{"$ref":"#/components/schemas/PayoutStatusPaymentInstrumentTrueLayer"},{"$ref":"#/components/schemas/PayoutStatusPaymentInstrumentTrustly"}],"discriminator":{"propertyName":"type","mapping":{"accessWorldpay":"#/components/schemas/PayoutStatusPaymentInstrumentAccessWorldpayBankPayout","applePay":"#/components/schemas/PaymentStatusPaymentInstrumentApplePay","astroPay":"#/components/schemas/PaymentStatusPaymentInstrumentAstroPayInstrument","bank2Bank":"#/components/schemas/PaymentStatusPaymentInstrumentBank2Bank","card":"#/components/schemas/PaymentStatusPaymentInstrumentCard","clickToPay":"#/components/schemas/PaymentStatusPaymentInstrumentClickToPay","ePay":"#/components/schemas/PaymentStatusPaymentInstrumentEPay","easyPay":"#/components/schemas/PaymentStatusPaymentInstrumentEasyPay","googlePay":"#/components/schemas/PaymentStatusPaymentInstrumentGooglePay","neteller":"#/components/schemas/PaymentStatusPaymentInstrumentNeteller","ottPayout":"#/components/schemas/PayoutStatusPaymentInstrumentOtt","paypal":"#/components/schemas/PayoutStatusPaymentInstrumentPayPal","paysafecard":"#/components/schemas/PaymentStatusPaymentInstrumentPaysafecard","pspToken":"#/components/schemas/PaymentStatusPaymentInstrumentPspTokenInstrument","revolutPay":"#/components/schemas/PaymentStatusPaymentInstrumentRevolutPay","skrill":"#/components/schemas/PaymentStatusPaymentInstrumentSkrill","trueLayer":"#/components/schemas/PayoutStatusPaymentInstrumentTrueLayer","trustly":"#/components/schemas/PayoutStatusPaymentInstrumentTrustly"}}},"PayInReference":{"description":"Make pay-outs to the same payment instrument as previous pay-ins if the pay-in uses the following Payment Instruments\n- Apple Pay - Google Pay - Revolut Pay\n","type":"object","required":["type","paymentId"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `PaymentInstrument` schema."},"paymentId":{"type":"string","description":"Identifier of the pay-in transaction","example":"00000000-0000-0000-0000-000000000000"}}},"PayoutResponse":{"type":"object","properties":{"code":{"type":"string","description":"[Response Code](https://docs.br-dge.io/docs/response-codes) signifying the outcome of the request.","example":"1000"},"id":{"type":"string","description":"The ID of this request. If you can include these when querying the outcome of individual requests, we can track down the root cause faster.\n","example":"a7f45953-1e8b-4f33-87b0-3293f4f6972f"},"message":{"type":"string","description":"A description of the outcome of the request."},"paymentId":{"type":"string","description":"The ID of this payment","example":"57f7f444-29ce-4230-8c7f-1c1fd85c8bc9"},"payoutEligibility":{"$ref":"#/components/schemas/PayoutEligibility"},"psp":{"$ref":"#/components/schemas/PspInfo"},"action":{"$ref":"#/components/schemas/Action"},"actionRequired":{"type":"boolean","default":false,"description":"Boolean value indicating whether further action should be taken after the response is received.","example":true},"merchantTransactionId":{"$ref":"#/components/schemas/MerchantTransactionId"},"riskAssessments":{"$ref":"#/components/schemas/PayoutRiskAssessments"},"paymentInstrument":{"$ref":"#/components/schemas/PaymentInstrumentPayoutResponse"},"amount":{"$ref":"#/components/schemas/AmountIncludingZero"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"blockingRule":{"$ref":"#/components/schemas/BlockingRule"},"pspProcessingMethod":{"$ref":"#/components/schemas/PspProcessingMethod"}}},"PayoutRequest":{"description":"Represents a request to transfer funds to your customer\n","required":["amount","currencyCode","paymentInstrument","recipient","reference"],"type":"object","properties":{"psp":{"description":"Identifier of the Payment Service Provider (PSP) you wish to route this request to. This is required if your retail channel is configured for more than one PSP.\n","allOf":[{"$ref":"#/components/schemas/PspName"}]},"amount":{"$ref":"#/components/schemas/Amount"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"recipient":{"$ref":"#/components/schemas/Recipient"},"paymentInstrument":{"$ref":"#/components/schemas/PayoutPaymentInstrument"},"reference":{"description":"A reference you can later use to identify this payout.\n\nPlease use only letters, numbers, spaces and these symbols: `'[]()@?!\\-/.,_&*:;+=`\n","type":"string","minLength":1,"maxLength":50,"example":"abc123"},"purpose":{"description":"The purpose of this payout\n\nPlease use only letters, numbers, spaces and these symbols: `'[]()@?!\\-/.,_&*:;+=`\n","type":"string","maxLength":50,"example":"leisure"},"customerId":{"$ref":"#/components/schemas/CustomerId"},"cashierId":{"$ref":"#/components/schemas/CashierId"},"riskInstruments":{"$ref":"#/components/schemas/PayoutRiskInstruments"},"merchantTransactionId":{"$ref":"#/components/schemas/MerchantTransactionId"},"customMetadata":{"$ref":"#/components/schemas/CustomMetadata"}}},"PayoutEligibilityType":{"type":"string","enum":["NOT_SUPPORTED","STANDARD","FAST_FUNDS","UNKNOWN"]},"PayoutEligibility":{"type":"object","properties":{"crossBorderGambling":{"description":"Whether the card is eligible for cross-border gambling transactions","allOf":[{"$ref":"#/components/schemas/PayoutEligibilityType"}]},"crossBorderMoneyTransfer":{"description":"Whether the card is eligible for cross-border money\n","allOf":[{"$ref":"#/components/schemas/PayoutEligibilityType"}]},"crossBorderNonMoneyTransfer":{"description":"Whether the card is eligible for cross-border non-money transfer transactions\n","allOf":[{"$ref":"#/components/schemas/PayoutEligibilityType"}]},"domesticGambling":{"description":"Whether the card is eligible for domestic gambling transactions\n","allOf":[{"$ref":"#/components/schemas/PayoutEligibilityType"}]},"domesticMoneyTransfer":{"description":"Whether the card is eligible for domestic money transfer\n","allOf":[{"$ref":"#/components/schemas/PayoutEligibilityType"}]},"domesticNonMoneyTransfer":{"description":"Whether the card is eligible for domestic non-money transfer transactions\n","allOf":[{"$ref":"#/components/schemas/PayoutEligibilityType"}]}}},"EasyPayPayment":{"title":"EasyPay","description":"A type of [Payment Instrument](https://docs.br-dge.io/docs/introduction#payment-instrument).\nEasyPay allows customers to make payments using cash.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `PaymentInstrument` schema."},"customerId":{"maxLength":255,"type":"string","description":"Unique ID linking the EasyPay request to a specific customer.","example":"123456"}}},"EasyPayPayout":{"allOf":[{"$ref":"#/components/schemas/EasyPayPayment"},{"type":"object","title":"EasyPay","description":"A type of Payment Instrument for payouts.\nEasyPay allows customers to make payouts using cash.\n","required":["type"],"properties":{"customerPaymentOptionId":{"maxLength":255,"type":"string","description":"This is the transaction ID from a previous EasyPay payment, linking the payout to a previously created payment option","example":"123456"},"easyPayEmail":{"maxLength":255,"type":"string","description":"The customer's EasyPay email address","example":"a@b.com"},"easyPayUserName":{"maxLength":255,"type":"string","description":"The customer's EasyPay username","example":"123456"},"easyPayPersonalId":{"maxLength":255,"type":"string","description":"The customer's EasyPay personal ID","example":"123456"},"easyPayIdentificationDate":{"type":"string","format":"date","description":"Issue date of recipient's personal document in the format YYYY-MM-DD (ISO 8601)","example":"2017-07-21"},"easyPayIdentificationNumber":{"maxLength":255,"type":"string","description":"Recipient's personal document number","example":"123456"},"easyPayIdentificationType":{"maxLength":1,"type":"string","description":"The type of personal document\n\n\n* 1: National ID\n* 2: Passport Number\n* 3: Tax ID\n* 4: Phone Number\n* 5: Email Address","example":"1"}}}]},"EPayPayment":{"title":"ePay.bg","description":"A type of [Payment Instrument](https://docs.br-dge.io/docs/introduction#payment-instrument).\nePay.bg is EasyPay’s digital platform supporting online transactions.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `PaymentInstrument` schema."},"customerId":{"maxLength":255,"type":"string","description":"Unique ID linking the ePay.bg request to a specific customer.","example":"123456"},"successUrl":{"maxLength":255,"pattern":"((https?)://)(www.)?[a-zA-Z0-9\\-@:%._\\+~#?&//=]{2,256}\\b([-a-zA-Z0-9@:%._\\+~#?&//=]*)","type":"string","description":"URL the customer is directed to after a successful transaction","example":"https://www.example.com/success"},"failureUrl":{"maxLength":255,"pattern":"((https?)://)(www.)?[a-zA-Z0-9\\-@:%._\\+~#?&//=]{2,256}\\b([-a-zA-Z0-9@:%._\\+~#?&//=]*)","type":"string","description":"URL the customer is directed to after an unsuccessful transaction","example":"https://www.example.com/unsuccessful"}}},"EPayPayout":{"title":"ePay.bg","description":"A type of Payment Instrument for payouts.\nePay.bg is EasyPay’s digital platform supporting online transactions.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `PaymentInstrument` schema."},"customerId":{"maxLength":255,"type":"string","description":"Customer ID linking the ePay.bg payout to a specific customer.","example":"123456"},"customerPaymentOptionId":{"maxLength":255,"type":"string","description":"This is the transaciton ID from a previous ePay.bg payment, linking the payout to a previously created payment option","example":"123456"},"epayCin":{"maxLength":255,"type":"string","description":"Customer's ePay.bg identification number","example":"123456"},"epayEmail":{"maxLength":255,"type":"string","description":"Customer's ePay.bg email eddress","example":"email@emailaddress.com"}}},"PaysafecardPayout":{"title":"Paysafecard","description":"A type of [Payment Instrument](https://docs.br-dge.io/docs/introduction#payment-instrument). Please see [here](https://docs.br-dge.io/docs/paysafecard-integration) for more information on this feature.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `PaymentInstrument` schema."},"paysafecardCustomerId":{"type":"string","description":"Identifier for the customer with Paysafecard's system","example":"151743187547"},"submerchantId":{"type":"string","maxLength":8,"description":"ID used to classify sub-merchants. Values must be agreed with Paysafecard.\n","example":"RCxD1234"}}},"NetellerPayout":{"title":"Neteller","description":"A type of [Payment Instrument](https://docs.br-dge.io/docs/introduction#payment-instrument).\nFor payouts using Neteller `payoutRequest.recipient.email` is mandatory.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `PaymentInstrument` schema."}}},"OttPayout":{"title":"OttPayout","description":"A type of [Payment Instrument](https://docs.br-dge.io/docs/introduction#payment-instrument).\nAllowing a transfer of funds directly into a customer's bank account, ability to issue vouchers for customers to use to withdraw funds or use with retailers.\n","required":["type","providerName"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `PayoutPaymentInstrument` schema."},"providerName":{"type":"string","description":"OTT provider name"},"bankDetails":{"$ref":"#/components/schemas/BankAccountDetails"}}},"Bank2BankPayout":{"title":"Bank2Bank","description":"A type of [Payment Instrument](https://docs.br-dge.io/docs/introduction#payment-instrument).\nAllowing a transfer of funds directly into a customer's bank account.\n","type":"object","required":["type","bankId","accountNumber","accountName"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `PaymentInstrument` schema."},"bankId":{"type":"string","description":"Unique reference to the bank with WalletDoc - found in WalletDoc's Bank2Bank API","example":"TYME"},"accountNumber":{"type":"string","description":"Beneficiary account number","example":"51000292680","maxLength":20},"accountName":{"type":"string","description":"Beneficiary account name","example":"Savings Account 123","maxLength":20},"branchCode":{"type":"string","description":"Branch code. If not provided, the bank's universal branch code is used.","example":"678910","maxLength":20}}},"AccessWorldpayBankPayout":{"title":"AccessWorldpay","description":"A type of [Payment Instrument](https://docs.br-dge.io/docs/introduction#payment-instrument).\n","type":"object","required":["type","bankDetails"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `PaymentInstrument` schema."},"bankDetails":{"$ref":"#/components/schemas/BankDetails"}}},"PspToken":{"title":"PspToken","description":"A type of [Payment Instrument](https://docs.br-dge.io/docs/introduction#payment-instrument) created directly with the PSP which can be used to make transactions. This payment instrument cannot be used in any payment flows which contains the card PAN (eg Kount/VISA Instalments) In the event of a BR-DGE outage, a merchant will process transactions directly with a PSP and new Card on File will be tokenized with the PSP but BR-DGE will not know about these tokens. BR-DGE will allow the merchant to process payments with these PSP tokens on the BR-DGE platform before migrating the tokenized instruments into BR-DGE.\n//Todo: schema description needs to be finalised.\n[Payment Instrument]: https://docs.br-dge.io/docs/introduction#payment-instrument\n","type":"object","required":["token","type","psp"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `PaymentInstrument` schema."},"token":{"maxLength":200,"minLength":1,"type":"string","description":"The token that represents a payment instrument.\n","example":"00000000-0000-0000-0000-000000000000"},"psp":{"$ref":"#/components/schemas/PspName"},"customerId":{"$ref":"#/components/schemas/CustomerId"},"cv2":{"maxLength":4,"minLength":3,"pattern":"^[0-9]*$","type":"string","description":"CV2 of the credit or debit card the this PSP token relates to","example":"123"},"tokenType":{"$ref":"#/components/schemas/PspTokenType"}}},"AstroPayCommon":{"description":"The common fields for all AstroPay instruments.","type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `PaymentInstrument` schema."},"userId":{"type":"string","maxLength":64,"description":"The customer's AstroPay User ID.","example":"Vx0H4pdAtPCz"}}},"PspTokenType":{"type":"string","example":"customer","description":"Identifies the type of a PSP token where a PSP offers different types of PSP tokens.\n\nCurrently supports:\n  - customer - [Cybersource Customer Token]\n  - paymentInstrument - [Cybersource Standalone Payment Instrument Token]\n    or [Cybersource Customer Payment Instrument Token]\n\n[Cybersource Customer Token]: https://developer.cybersource.com/api-reference-assets/index.html#token-management_customer_create-a-customer\n[Cybersource Standalone Payment Instrument Token]: https://developer.cybersource.com/api-reference-assets/index.html#token-management_payment-instrument_create-a-payment-instrument\n[Cybersource Customer Payment Instrument Token]: https://developer.cybersource.com/api-reference-assets/index.html#token-management_customer-payment-instrument_create-a-customer-payment-instrument\n","maxLength":64},"AstroPayPayout":{"description":"A type of [Payment Instrument] for performing AstroPay payouts.\nEither userId or phoneNumber must be supplied.\n[Payment Instrument]: https://docs.br-dge.io/docs/introduction#payment-instrument\n","title":"AstroPay","required":["type"],"allOf":[{"$ref":"#/components/schemas/AstroPayCommon"},{"type":"object","properties":{"phoneNumber":{"maxLength":50,"pattern":"^$|^[+]?[(0-9][0-9 ()-]*[0-9]$","type":"string","description":"Telephone number of the customer. If userId is not supplied a text message will be sent\nto enable the customer to complete the payout.\n\nPlease use only numbers, spaces and an optional leading +. Country code must be included.","example":"+55 8534326168"},"country":{"$ref":"#/components/schemas/CountryIsoCode"}}}]},"SkrillPayout":{"description":"A type of [Payment Instrument] for performing Skrill payouts.\nWhen using this payment instrument an email address must be provided. This is used by Skrill to identify the payout recipient's Skrill account.\n\n- For Skrill payouts `payoutRequest.recipient.email` is mandatory.\n\n[Payment Instrument]: https://docs.br-dge.io/docs/introduction#payment-instrument\n","title":"Skrill","allOf":[{"$ref":"#/components/schemas/SkrillPayment"}]},"CaptureRequest":{"type":"object","properties":{"amount":{"title":"amount","type":"integer","format":"int64","minimum":1,"maximum":999999999999999,"example":1234,"description":"Amount to be captured on a payment that has been previously authorized but not settled.\nIn the lowest denomination of the currency of the payment.\nThis means that `1234` in GBP represents `£12.34`.\n"}}},"RefundRequest":{"title":"RefundRequest","description":"Represents a request to refund all or part of an existing payment","type":"object","properties":{"amount":{"title":"amount","type":"integer","format":"int64","minimum":1,"maximum":999999999999999,"example":1234,"description":"Amount to be refunded on this transaction, or null for full refund.\nIn the lowest denomination of the currency of the payment.\nThis means that `1234` in GBP represents `£12.34`.\n"},"merchantTransactionId":{"$ref":"#/components/schemas/MerchantTransactionId"},"customerRefundCode":{"$ref":"#/components/schemas/CustomerRefundCode"}}},"Order":{"type":"object","required":["amount","currencyCode","customerEmail","customerFirstName","customerOrderCode","orderDescription","returnUrl"],"properties":{"allowedPaymentInstruments":{"type":"array","example":["applePay","card"],"description":"By default, the BR-DGE Hosted Payment Page will attempt to offer all possible payment methods based on a range of criteria including:\n- The payment methods that are enabled on your retail channels.\n- The availability of PSPs connected to your retail channel, and the payment\n  methods they support.\n\n- The payment methods that are supported by your customers' web browser.\nAs it is sometimes useful to limit the available payment methods on a per-order basis, you have the option to specify a set of allowed payment methods when creating an order via `POST /orders`. This will result in only the payment methods specified in the set being offered to your customer as part of the order.\n\nPossible values:\n- `card`\n- `applePay`\n- `googlePay`\n- `payPal`\n- `astroPay`\n- `visaInstalments` please note that you should also enable `card`\n  if you wish to enable Visa Installments.\n\n- `trustly`\n","items":{"$ref":"#/components/schemas/OrderPaymentInstrumentType"}},"amount":{"$ref":"#/components/schemas/Amount"},"billingAddress":{"$ref":"#/components/schemas/Address"},"cardOnFileTermsAndConditionsUrl":{"type":"string","example":"http://example.com/terms","description":"Link to terms and conditions relating to saving card details.\nIf `cardOnFileTermsAndConditionsUrl` is specified and `customerAgreedToSaveCard`` is set to true then a message will be displayed to your customer notifying them that their card details will be saved according to the linked terms and conditions.\nIf `cardOnFileTermsAndConditionsUrl` is specified and `customerAgreedToSaveCard` is not specified or set to false then your customer will be given the opportunity to agree to the linked terms and conditions and have their card details saved.\n","pattern":"((https?)://)(www.)?[a-zA-Z0-9\\-@:%._\\+~#?&//=]{2,256}\\b([-a-zA-Z0-9@:%._\\+~#?&//=]*)"},"corporateCardPercentageSurcharge":{"type":"number","format":"double","minimum":0,"exclusiveMinimum":true,"maximum":100,"example":12.5,"description":"If provided then when BR-DGE detects a shopper using a corporate card we will automatically apply a surcharge to the base amount for the order. Your customer will be notified of any surcharges and given the option to use an alternative payment method.\n"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"customerAgreedToSaveCard":{"type":"boolean","default":false,"description":"If [Credentials On File Mandate requirements](https://docs.br-dge.io/docs/vault#credentials-on-file-mandate-compliance) relating to cardholder consent has been met prior to creating an order you can set this flag to ensure that the Hosted Payment Page always creates a BR-DGE Card on File if your customer enters card details.\n\nPlease note that if you set this to true then you also need to provide a link to the agreement via the `cardOnFileTermsAndConditionsUrl` field.\n"},"cardOnFileSaveEnabled":{"type":"boolean","default":false,"description":"Determines if the save card checkbox is to be displayed or not.\n"},"customerEmail":{"type":"string","example":"a@b.com","description":"Email address of the customer","minLength":1,"maxLength":254,"pattern":"^$|^[a-zA-Z0-9._%'+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$"},"customerFirstName":{"description":"First name of the customer (customerFirstName length plus customerLastName length must be less than 255 characters long)\n","type":"string","minLength":1,"maxLength":255,"example":"John"},"customerId":{"description":"Associate order with a customer identifier. Any pre-existing BR-DGE Card on Files for the customer will automatically be presented as payment methods and any new BR-DGE Cards on File will be associated with the customer.\nPlease use only letters, numbers, spaces and these symbols: `'[]()@?!\\-/.,_&*:;+=`\n","type":"string","minLength":1,"maxLength":100,"example":"john@doe.com"},"customerLastName":{"description":"Last name of the customer (customerFirstName length plus customerLastName length must be less than 255 characters long)\n","type":"string","minLength":1,"maxLength":255,"example":"Smith"},"customerOrderCode":{"$ref":"#/components/schemas/CustomerOrderCode"},"customerPhoneNumber":{"type":"string","example":"+44 123 1110000","description":"Telephone number of the customer","maxLength":255,"pattern":"^$|^[+]?[(0-9][0-9 ()-]*[0-9]$"},"deliveryAddress":{"$ref":"#/components/schemas/Address"},"intent":{"type":"string","default":"capture","description":"By default payments are captured immediately, but you can you can choose to split the authorization and the capture of the payment.\n * `authorize` - if you intend to capture separately using\n   `POST /payments/{paymentId}/capture`\n * `capture` - If you intend to capture immediately\n"},"merchantInitiated":{"type":"string","description":"Only set this field if you are using the Hosted Payment Page to perform an initial Merchant Initiated Transaction (MIT).\n\nFor more information see [here].\n\nPossible values:\n- `unscheduled` An unscheduled charge for a service such as e-scooter hire\n- `recurring` A recurring payment for a magazine subscription\n\n[here]: https://docs.br-dge.io/docs/vault#making-merchant-initiated-transactions-mits-using-card-on-file\n","enum":["unscheduled","recurring"]},"orderDescription":{"description":"Description of what the order is for\n\nPlease use only letters, numbers, spaces and these symbols: `'[]()@?!\\-/.,_&*:;+=`\n","type":"string","minLength":1,"maxLength":255,"example":"Taxi fare"},"returnUrl":{"type":"string","example":"http://www.return.url","description":"Return URL for confirmed order","pattern":"((http|https)://)(www.)?[a-zA-Z0-9\\-@:%._\\+~#?&//=]{2,256}\\.[a-z]{2,6}\\b([-a-zA-Z0-9@:%._\\+~#?&//=]*)"},"threeDSecureOptions":{"$ref":"#/components/schemas/ThreeDSecureOptions"},"threeDSecureRequired":{"type":"boolean","description":"You can indicate that 3-D Secure processing is preferred, usually initializing a 3-D Secure authentication flow.\n\nNote that setting this as true does not guarantee that the payment will end up with successful 3-D Secure authentication. Also, setting this to false does not guarantee that 3-D Secure authentication will not be applied to the payment, as some PSPs may choose to apply their own rules around this regardless need to opt-in to 3-D Secure authentication on a per-payment basis.\n","example":true},"tokens":{"description":"A comma-delimited set of BR-DGE Card on File multi-use tokens to be offered as payment methods for the order.\n\nPlease use only letters, numbers, spaces and these symbols: `'[]()@?!\\-/.,_&*:;+=`\n","type":"string","minLength":1,"maxLength":200,"example":"token1,token2"},"payPal":{"$ref":"#/components/schemas/PayPalHppOrderDetails"}},"title":"Order","description":"Class representing an order tracked by the application."},"PayPalHppOrderDetails":{"type":"object","title":"PayPal","description":"Additional configuration if PayPal is enabled within your order and Retail Channel.\n","properties":{"invoiceId":{"description":"Merchant provided invoice number for the order.\n\nPlease use only letters, numbers, spaces and these symbols: `'[]()@?!\\-/.,_&*:;+=`\n","type":"string","minLength":1,"maxLength":255,"example":"987654321"},"customerAccountId":{"description":"Customer's account ID with the merchant.\n\nPlease use only letters, numbers, spaces and these symbols: `'[]()@?!\\-/.,_&*:;+=`\n","type":"string","minLength":1,"maxLength":255,"example":"A12345N343"},"customerAccountCreationTimestamp":{"description":"The date and time that the customers account was created.","type":"string","example":"2022-01-30T10:10:10Z"},"enableShippingAddress":{"type":"boolean","example":true,"description":"Dictates display of shipping address selection during PayPal payment. If an address is\nsupplied in deliveryAddress it will be displayed regardless of the value of this field.\n"},"shippingAddressEditable":{"type":"boolean","example":false,"description":"Dictates display of shipping address selection during PayPal payment regardless of if a\nshipping address override is present.\n"},"displayName":{"description":"Business name which overrides the name in the PayPal account.\n\nPlease use only letters, numbers, spaces and these symbols: `'[]()@?!\\-/.,_&*:;+=`\n","type":"string","minLength":1,"maxLength":255,"example":"Display Name"},"locale":{"type":"string","description":"The end-users localization preference in the format [language[_territory]]. Language is the ISO 639-1 code and territory the ISO 3166 Alpha-2 code.\n","example":"en_GB","minLength":5,"maxLength":5,"pattern":"^[a-z]{2}_[A-Z]{2}"},"lineItems":{"$ref":"#/components/schemas/LineItemsList"},"ota":{"$ref":"#/components/schemas/PayPalOnlineTravelAgency"}}},"OrderResponse":{"title":"OrderResponse","type":"object","properties":{"code":{"description":"A unique identifier covering the outcome of the request","type":"string","example":"1000"},"id":{"description":"The ID of this request","type":"string","example":"4fad8e2e06a15656"},"message":{"description":"A description of the outcome of the request","type":"string"},"orderId":{"description":"The ID of this order","type":"string"},"redirectUrl":{"description":"The URL to redirect your customer to in progress the order","type":"string"}}},"OrderStatusResponse":{"title":"OrderStatusResponse","description":"Last known status of an Order","type":"object","properties":{"code":{"description":"A numeric code which indicates the status of the order","type":"string","example":"1005"},"message":{"description":"A textual description of the status of the order","type":"string","example":"Order created"},"creationTimestamp":{"description":"The date and time that the order was created","type":"string","example":"2022-01-30T10:10:10Z"},"lastUpdatedTimestamp":{"description":"The date and time that the order was last updated or cancelled. Note: the date and time that a payment is made for this order does not affect the value of this field.\n","type":"string","example":"2022-01-30T10:10:10Z"},"cardOnFileTokenCreated":{"description":"If a Card on File was created as part of this order, then this field will be populated with the multi-use token for the Card on File.\n","type":"string"},"payments":{"description":"A list of up to three payment attempts in descending time order\n","type":"array","items":{"title":"PaymentDetails","type":"object","description":"Details of an individual payment attempt.\n","properties":{"paymentId":{"description":"Unique identifier for the payment","type":"string","example":"db805559-7cc4-4866-9e52-0b60fa59f12b"},"code":{"description":"A unique identifier covering the outcome of the request.","type":"string","example":"1000"},"message":{"description":"A description of the outcome of the request.","type":"string","example":"Withdrawal limit exceeded"},"timestamp":{"description":"Timestamp for when the payment attempt was made","type":"string","example":"2022-01-30T10:10:10Z"},"paymentInstrument":{"$ref":"#/components/schemas/OrderPaymentInstrument"},"psp":{"$ref":"#/components/schemas/PspInfo"},"avsResult":{"$ref":"#/components/schemas/AvsResult"}}}}}},"OrderPaymentInstrument":{"oneOf":[{"$ref":"#/components/schemas/OrderPaymentInstrumentCard"},{"$ref":"#/components/schemas/OrderPaymentInstrumentApplePay"},{"$ref":"#/components/schemas/OrderPaymentInstrumentGooglePay"},{"$ref":"#/components/schemas/OrderPaymentInstrumentPayPal"},{"$ref":"#/components/schemas/OrderPaymentInstrumentPayPalOrder"},{"$ref":"#/components/schemas/OrderPaymentInstrumentVisaInstalments"},{"$ref":"#/components/schemas/OrderPaymentInstrumentAstroPay"},{"$ref":"#/components/schemas/OrderPaymentInstrumentTrustly"}],"discriminator":{"propertyName":"type","mapping":{"card":"#/components/schemas/OrderPaymentInstrumentCard","applePay":"#/components/schemas/OrderPaymentInstrumentApplePay","googlePay":"#/components/schemas/OrderPaymentInstrumentGooglePay","payPal":"#/components/schemas/OrderPaymentInstrumentPayPal","visaInstalments":"#/components/schemas/OrderPaymentInstrumentVisaInstalments","astroPay":"#/components/schemas/OrderPaymentInstrumentAstroPay","trustly":"#/components/schemas/OrderPaymentInstrumentTrustly","payPalOrder":"#/components/schemas/OrderPaymentInstrumentPayPalOrder"}}},"OrderPaymentInstrumentCard":{"description":"Returned when an order was paid using a card Payment Instrument.","title":"card","type":"object","required":["pan","expiryDate","type"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `OrderPaymentInstrument` schema."},"nameOnCard":{"type":"string","example":"John F Doe"},"pan":{"type":"string","example":"1234 56## #### 1111"},"expiryDate":{"$ref":"#/components/schemas/CardExpiryDate"},"startDate":{"type":"string","description":"Start date of the credit or debit card.","example":"01-00"},"issueNumber":{"maximum":9,"minimum":1,"type":"integer","description":"Issue number of the credit or debit card.","format":"int32","example":1},"cardMetadata":{"$ref":"#/components/schemas/CardMetadata"}}},"OrderPaymentInstrumentApplePay":{"description":"Returned when an order was paid using an Apple Pay Payment Instrument.","title":"Apple Pay","type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `OrderPaymentInstrument` schema."}}},"OrderPaymentInstrumentGooglePay":{"description":"Returned when an order was paid using a Google Pay Payment Instrument.","title":"Google Pay","type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `OrderPaymentInstrument` schema."}}},"OrderPaymentInstrumentPayPal":{"description":"Returned when an order was paid using PayPal Payment Instrument.","title":"PayPal","type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `OrderPaymentInstrument` schema."}}},"OrderPaymentInstrumentPayPalOrder":{"description":"Returned when an order was paid using PayPal Order Payment Instrument.","title":"PayPal Order","type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `OrderPaymentInstrument` schema."},"intent":{"type":"string","description":"The intent of the payment","example":"capture"},"orderId":{"type":"string","description":"The Id of the Paypal Order","example":"0LF24497F4100755H"}}},"OrderPaymentInstrumentVisaInstalments":{"description":"Returned when an order was paid using a Visa Instalments Payment Instrument.","title":"Visa Instalments","type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `OrderPaymentInstrument` schema."}}},"PaymentRecipient":{"type":"object","description":"Recipient of a payment required in some type of transactions, such as AFTs.\n","allOf":[{"$ref":"#/components/schemas/Recipient"},{"type":"object","properties":{"middleName":{"description":"Middle name of the recipient.\n","type":"string","maxLength":255,"example":"Michael"},"accountNumber":{"description":"The recipient's destination account reference for the funding transaction.\nDepending on `accountType` this may be a bank account number, IBAN, masked\nor partial card number, wallet ID, email address or phone number. A full,\nunmasked card number is rejected.\n","type":"string","maxLength":50,"example":"GB29NWBK70361331946864"},"accountType":{"description":"The type of account held in `accountNumber` field.\n","type":"string","enum":["BANK_ACCOUNT","IBAN","CARD","EMAIL","PHONE","BAN_BIC","WALLET_ID","SOCIAL_NETWORK_ID"],"example":"IBAN"}}}]},"Recipient":{"type":"object","properties":{"title":{"description":"Title of the recipient.","type":"string","minLength":1,"maxLength":10,"example":"Mrs"},"firstName":{"description":"First name of the recipient.\n\nPlease note that the combined length of `firstName` and `lastName` must not exceed 255 characters.\n","type":"string","maxLength":255,"example":"John"},"lastName":{"description":"Last name of the recipient.\n\nPlease note that the combined length of `firstName` and `lastName` must not exceed 255 characters.\n","type":"string","maxLength":255,"example":"Smith"},"ipAddress":{"$ref":"#/components/schemas/IpAddress"},"customerId":{"$ref":"#/components/schemas/CustomerId"},"documentIssuer":{"$ref":"#/components/schemas/CountryIsoCode"},"documentId":{"maxLength":255,"type":"string","description":"The ID number of a customer's identity document\nE.g. passport number or national identity card number etc","example":"ABC-123456"},"documentType":{"maxLength":255,"type":"string","description":"The type of identification document\nE.g. passport, national identity card, tax ID, etc","example":"DNI"},"email":{"type":"string","description":"Email address of the customer","example":"john.smith@example.com"},"gender":{"type":"string","description":"Payout recipient's gender","example":"male"},"dateOfBirth":{"$ref":"#/components/schemas/DateOfBirth"},"address":{"$ref":"#/components/schemas/DomicileAddress"},"phoneNumber":{"$ref":"#/components/schemas/PhoneNumber"}}},"ThreeDSecureOptions":{"title":"ThreeDSecureOptions","description":"Some Payment Service Providers allow you to pass parameters to indicate your preferences relating to 3-D Secure.\n\nNote: We cannot guarantee that downstream Payment Service Providers will honour your preferences, but we can ensure that your preferences are passed on whenever possible.\n","type":"object","properties":{"challengeRequested":{"type":"boolean","description":"Indicates whether the payment request should result in a 3-D Secure challenge and not experience a frictionless flow, if handled by a payment service provider that supports this feature.","example":false},"exemptionRequested":{"type":"boolean","description":"Indicates whether the payment request should be considered for a 3D Secure exemption, if handled by a payment service provider that supports this feature.\n\nDEPRECATED: the 'scaExemption' field should be used instead.\n","deprecated":true,"example":false},"automaticallyStepUp":{"type":"boolean","description":"Attempt a payment without 3DSecure, and if 3DSecure is requested from the PSP, automatically re-attempt the payment with 3DSecure.\n","example":false}}},"OrderPaymentInstrumentType":{"type":"string","enum":["card","applePay","googlePay","payPal","visaInstalments","trustly","astroPay"],"example":"card"},"OrderPaymentInstrumentTrustly":{"description":"Returned when an order was paid using an Trustly Payment Instrument.","title":"Trustly","type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `OrderPaymentInstrument` schema."}}},"OrderPaymentInstrumentAstroPay":{"description":"Returned when an order was paid using an AstroPay Payment Instrument.","title":"AstroPay","type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `OrderPaymentInstrument` schema."}}},"PaymentResponsePaymentInstrument":{"description":"The obfuscated details of a Payment Instrument.\nCan be one of many different instrument types.\n","oneOf":[{"$ref":"#/components/schemas/PaymentResponseCard"},{"$ref":"#/components/schemas/PaymentResponseTokenized"},{"$ref":"#/components/schemas/PaymentResponseApplePay"},{"$ref":"#/components/schemas/PaymentResponseGooglePay"},{"$ref":"#/components/schemas/PaymentResponseIssuerResponse"}],"discriminator":{"propertyName":"type","mapping":{"card":"#/components/schemas/PaymentResponseCard","tokenized":"#/components/schemas/PaymentResponseTokenized","applePay":"#/components/schemas/PaymentResponseApplePay","googlePay":"#/components/schemas/PaymentResponseGooglePay","issuerResponse":"#/components/schemas/PaymentResponseIssuerResponse"}}},"PaymentResponseCard":{"description":"The obfuscated details of a Card Payment Instrument.","allOf":[{"$ref":"#/components/schemas/BasePaymentResponsePaymentInstrument"},{"$ref":"#/components/schemas/DetailsOfAssociatedCardPaymentInstrument"}]},"PaymentResponseTokenized":{"description":"The obfuscated details of a Tokenized Payment Instrument.","allOf":[{"$ref":"#/components/schemas/BasePaymentResponsePaymentInstrument"},{"$ref":"#/components/schemas/DetailsOfAssociatedCardPaymentInstrument"}]},"PaymentResponseApplePay":{"description":"The obfuscated details of a Apple Pay Payment Instrument.","allOf":[{"$ref":"#/components/schemas/BasePaymentResponsePaymentInstrument"},{"$ref":"#/components/schemas/ApplePayDetails"}]},"PaymentResponseGooglePay":{"description":"The obfuscated details of a Google Pay Payment Instrument.","allOf":[{"$ref":"#/components/schemas/BasePaymentResponsePaymentInstrument"},{"$ref":"#/components/schemas/GooglePayDetails"}]},"PaymentResponseIssuerResponse":{"description":"Raw Issuer Details.","allOf":[{"$ref":"#/components/schemas/BasePaymentResponsePaymentInstrument"},{"$ref":"#/components/schemas/IssuerResponseDetails"}]},"IssuerResponse":{"description":"BR-DGE allows you to directly access the original responses from card issuers for transactions processed through [payment processors] that offer the \"Card Issuer Raw Responses\" feature.\n\n[payment processors]: https://docs.br-dge.io/docs/psp-integrations\n","type":"object","properties":{"issuerPaymentMethod":{"description":"MASTERCARD, VISA, etc","type":"string","example":"VISA_DEBIT-SSL"},"issuerCardType":{"description":"The payment card type","type":"string","example":"debitcard"},"merchantAdviceCode":{"description":"Merchant Advice","type":"string","example":"retry_later"},"type":{"description":"This field is unnecessary and will be removed.\n\n\nDEPRECATED: Do not use, it contains no useful information.\n","deprecated":true,"type":"string"},"issuerResponse":{"description":"This field provides duplicate Details from the issuer, already available on the same level.\n\n\nDEPRECATED: Do not use, all the relevant fields are available on the same level as this object.\n","deprecated":true,"type":"object","properties":{"issuerPaymentMethod":{"description":"MASTERCARD, VISA, etc\n\n\nDEPRECATED: The same information should be accessed from one level up.\n","deprecated":true,"type":"string","example":"VISA_DEBIT-SSL"},"issuerCardType":{"description":"The payment card type\n\n\nDEPRECATED: The same information should be accessed from one level up.\n","deprecated":true,"type":"string","example":"debitcard"},"merchantAdviceCode":{"description":"Merchant Advice\n\n\nDEPRECATED: The same information should be accessed from one level up.\n","deprecated":true,"type":"string","example":"retry_later"}}}}},"BasePaymentResponsePaymentInstrument":{"description":"General fields which are valid for a payment instrument.","type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `PaymentInstrument` schema."}}},"IssuerResponseDetails":{"description":"Raw Issuer Details","type":"object","properties":{"issuerResponse":{"$ref":"#/components/schemas/IssuerResponse"}}},"DetailsOfAssociatedCardPaymentInstrument":{"type":"object","description":"Reusable details which can be returned on various card payment instrument backed payment instrument types. All details which are returned here are considered obfuscated.\n","properties":{"metadata":{"$ref":"#/components/schemas/CardMetadata"},"expiryDate":{"$ref":"#/components/schemas/CardExpiryDate"},"fingerprint":{"$ref":"#/components/schemas/Fingerprint"},"fingerprintExtended":{"$ref":"#/components/schemas/FingerprintExtended"}}},"CardMetadata":{"type":"object","description":"If a card payment instrument is used then BR-DGE may be able to provide metadata about the card\n\n**Please note: All text will be UPPERCASE and all fields can be null**\n","properties":{"cardBrand":{"type":"string","example":"MASTERCARD","description":"MASTERCARD, VISA, etc"},"issuer":{"type":"string","description":"Name of issuing bank"},"type":{"type":"string","enum":["DEBIT","CREDIT","CHARGE_CARD","CHARGE","DEFERRED_DEBIT","PREPAID","PREPAID_RELOADABLE","UNKNOWN"]},"category":{"type":"string","example":"CLASSIC","description":"CLASSIC, BUSINESS, MIXED_PRODUCT, etc"},"countryIsoA2":{"$ref":"#/components/schemas/CountryIsoCode"},"commercial":{"type":"boolean","description":"Indicates if the card is corporate or retail","example":true},"bin":{"type":"string","description":"The Bank Identification Number that identifies the bank or financial institution that issued the card","example":"48321456","pattern":"^[0-9]+$","minLength":6,"maxLength":8}}},"CardExpiryDate":{"type":"string","example":"05-25","description":"Card expiry date in MM-YY format.\n"},"Fingerprint":{"type":"string","description":"A unique token that can be used to detect if two BR-DGE tokens represent the same underlying Payment Instrument.\n","example":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c6"},"FingerprintExtended":{"type":"string","description":"A fingerprint with card expiry date appended in MMYY format.\n"},"ApplePayDetails":{"description":"Additional information about Apple Pay Payment Instruments.","allOf":[{"$ref":"#/components/schemas/DetailsOfAssociatedCardPaymentInstrument"},{"type":"object","description":"Decrypted Apple Pay information and card metadata\n","properties":{"decryptedPayload":{"$ref":"#/components/schemas/ApplePayDecryptedPayload"},"paymentMethod":{"$ref":"#/components/schemas/ApplePayPaymentMethod"}}}]},"GooglePayDetails":{"description":"Additional information about Google Pay Payment Instruments.","allOf":[{"$ref":"#/components/schemas/DetailsOfAssociatedCardPaymentInstrument"},{"type":"object","description":"Decrypted Google Pay information and card metadata\n","properties":{"decryptedPayload":{"$ref":"#/components/schemas/GooglePayDecryptedPayload"}}}]},"GooglePayDecryptedPayload":{"type":"object","description":"[Google Pay decrypted payload] excluding sensitive fields, such as cryptogram\n\n[Google Pay decrypted payload]: https://developers.google.com/pay/api/android/guides/resources/payment-data-cryptography#encrypted-message\n","properties":{"gatewayMerchantId":{"type":"string","example":"some-merchant-id","description":"Google Pay gateway merchant ID."},"messageExpiration":{"type":"string","example":"1650574736277","description":"Date and time at which the message expires as UTC milliseconds since epoch.\n"},"messageId":{"type":"string","example":"AH2Ejtc88ZHJ-2aYBQWzHwvp6l0JsCHgxVt8s91A-ZUikaXNbcjsFm6gg9ExeVR-jzIyT-mJvA_ntvfRsDDOH2jnKMjdTtXIJvPt0NBUU45R7-gnjxkx-sI0ldcWvbDHsV0735yFDbWk","description":"A unique ID that identifies the message in case it needs to be revoked or located at a later time.\n"},"paymentMethod":{"type":"string","example":"CARD","enum":["CARD"],"description":"The type of the payment credential. Currently, only CARD is supported.\n"},"paymentMethodDetails":{"$ref":"#/components/schemas/GooglePayDecryptedPaymentMethodDetails"}}},"GooglePayDecryptedPaymentMethodDetails":{"type":"object","description":"The Google Pay payment credential, excluding cryptogram.","properties":{"pan":{"type":"string","example":"####-####-####-4444","description":"The personal account number of the card that the Google Pay token relates to.\nThe value of this field depends on the value of `authMethod`.\n  - If authMethod is PAN_ONLY:\n    - This is an obfuscated PAN, where only the last 4 digits are present.\n  - If authMethod is CRYPTOGRAM_3DS:\n    - This is the full DPAN value generated by Google Pay.\n"},"expirationMonth":{"type":"integer","example":5,"description":"The expiration month of the card, where 1 represents January, 2 represents February, and so on."},"expirationYear":{"type":"integer","example":2025,"description":"The four-digit expiration year of the card, such as 2020."},"authMethod":{"type":"string","example":"PAN_ONLY","description":"The authentication method of the card transaction.","enum":["PAN_ONLY","CRYPTOGRAM_3DS"]},"eciIndicator":{"type":"string","example":"07","description":"This string isn’t always present. It returns only for authenticated device tokens transactions on Android (CRYPTOGRAM_3DS). This value must be passed down the payment processing flow.\n\nPossible values: \"\"(empty), 02, 06, 05, 07\n"},"assuranceDetails":{"$ref":"#/components/schemas/GooglePayDecryptedAssuranceDetails"},"cardLastFour":{"type":"string","example":"4444","description":"The last four digits of the PAN"}}},"GooglePayDecryptedAssuranceDetails":{"type":"object","description":"This object provides information about the validation performed on the returned payment data.","properties":{"accountVerified":{"type":"boolean","description":"If true, indicates that Cardholder possession validation has been performed on returned payment credential.\n"},"cardholderAuthenticated":{"type":"boolean","description":"If true, indicates that identification and verifications (ID&V) was performed on the returned payment credential.\n\nIf false, the same risk-based authentication can be performed as you would for card transactions. This risk-based authentication can include, but is not limited to, 3D-Secure authentication if applicable.\n"}}},"ApplePayDecryptedPayload":{"type":"object","description":"[Apple Pay decrypted payload] excluding sensitive fields, such as cryptogram\n\n[Apple Pay decrypted payload]: https://developer.apple.com/documentation/passkit_apple_pay_and_wallet/apple_pay/payment_token_format_reference#3949536\n","required":["applicationPrimaryAccountNumber","applicationExpirationDate","currencyCode","transactionAmount","deviceManufacturerIdentifier","paymentDataType","paymentData","transactionId"],"properties":{"applicationPrimaryAccountNumber":{"type":"string","example":"4818528840216497","description":"Device-specific account number of the card that funds this transaction"},"applicationExpirationDate":{"type":"string","example":"281231","description":"Card expiration date in the format YYMMDD"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCodeNumeric"},"transactionAmount":{"example":100,"type":"integer","description":"Transaction amount in the lowest denomination of the given currency"},"deviceManufacturerIdentifier":{"example":"040010030273","type":"string","description":"Hex-encoded device manufacturer identifier"},"paymentDataType":{"example":"3DSecure","type":"string","description":"Transaction type.\n\nEMV relates to POS terminal transactions. 3D-Secure relates to ecommerce transactions.\n","enum":["3DSecure","EMV"]},"paymentData":{"$ref":"#/components/schemas/ApplePayDecryptedPaymentData"},"transactionId":{"example":"31675461ec268fed0ca9699e632753447d1a1de0aa65170e049033d7a801d3f3","type":"string","description":"Transaction identifier, generated on the device.\n\nRetrieved from [header] of decoded Apple Pay token.\n\n[header]: https://developer.apple.com/documentation/passkit_apple_pay_and_wallet/apple_pay/payment_token_format_reference#3949539\n"},"cardholderName":{"type":"string","example":"John Doe","description":"Optional field containing cardholder's name if present"}}},"ApplePayDecryptedPaymentData":{"type":"object","description":"Detailed payment data, excluding cryptogram","properties":{"eciIndicator":{"type":"integer","example":7,"description":"Optional. ECI indicator, as defined by 3D-Secure.\n\nThe card network may add an ECI indicator to the payment data that the payment token includes.\n"}}},"ApplePayPaymentMethod":{"type":"object","description":"Details from the `paymentMethod` section of the ApplePay token","properties":{"displayName":{"type":"string","example":"MasterCard 0839"},"network":{"type":"string","example":"MasterCard"},"type":{"type":"string","example":"credit"}}},"ClickToPayDetails":{"description":"Additional information about Click to Pay Payment Instruments.","allOf":[{"$ref":"#/components/schemas/DetailsOfAssociatedCardPaymentInstrument"},{"type":"object","description":"Decrypted Apple Pay information and card metadata\n","properties":{"payload":{"$ref":"#/components/schemas/ClickToPayPayload"}}}]},"ClickToPayPayload":{"type":"object","description":"The Click to Pay payload contains the decrypted payload information as well as ECI indicator via the `assuranceData` object.\n","properties":{"assuranceData":{"type":"object","description":"The assurance data object contains the ECI indicator used in the payment.\n","properties":{"eci":{"type":"string","description":"The ECI indicator for the Click to Pay payment.\n"}}},"decryptedPayload":{"type":"object","description":"The payload decrypted from the Click to Pay token used in the payment.\n","properties":{"token":{"type":"object","description":"The decrypted Click to Pay network token.\n","properties":{"paymentToken":{"type":"string","description":"The DPAN from the decrypted Click to Pay network token.\n","example":"4123123412341234"},"tokenExpirationMonth":{"type":"string","description":"The expiration month from the decrypted Click to Pay network token.\n","example":"11"},"tokenExpirationYear":{"type":"string","description":"The expiration year from the decrypted Click to Pay network token.\n","example":"2027"},"paymentAccountReference":{"type":"string","description":"The payment account reference (PAR) from the decrypted Click to Pay network token.\n","example":"PAR0987654321"}}},"billingAddress":{"type":"object","description":"The billing address within the Click to Pay payment.\n","properties":{"name":{"type":"string","example":"John Doe"},"line1":{"type":"string","example":"123 Test Town"},"line2":{"type":"string","example":"Stanhope House"},"line3":{"type":"string","example":"Haymarket"},"city":{"type":"string","example":"Edinburgh"},"state":{"type":"string","example":"Scotland"},"zip":{"type":"string","example":"TE12ST"},"countryCode":{"type":"string","example":"GB"}}},"consumerFullName":{"type":"string","description":"The full name of the customer from the decrypted Click to Pay token.\n","example":"John Doe"},"consumerFirstName":{"type":"string","description":"The first name of the customer from the decrypted Click to Pay token.\n","example":"John"},"consumerLastName":{"type":"string","description":"The last name of the customer from the decrypted Click to Pay token.\n","example":"Doe"},"dynamicData":{"type":"array","description":"The dynamic data array contains information such as the network token cryptogram to go with the DPAN.\n","items":{"type":"object","properties":{"dynamicDataValue":{"type":"string"},"dynamicDataType":{"type":"string"}}}}}}}},"CountryIsoCode":{"type":"string","description":"ISO 3166 Alpha-2 Country code","example":"GB","minLength":2,"maxLength":2,"pattern":"^[A-Z]+$"},"DateOfBirth":{"description":"Date of birth of the referenced person. While this field is not required by the BR-DGE API; it is highly recommended as some PSPs recommend the inclusion of this field. If you have any questions about whether you should provide customer date of birth, please raise a ticket with the [BR-DGE Support Centre](https://support.br-dge.io/support/home).\n","type":"string","format":"date","example":"2024-02-24"},"PayoutPaymentInstrument":{"type":"object","description":"Electronic instrument with which end users of payment systems use to transfer funds between accounts at banks or other financial institutions.\n","oneOf":[{"$ref":"#/components/schemas/AccessWorldpayBankPayout"},{"$ref":"#/components/schemas/AstroPayPayout"},{"$ref":"#/components/schemas/Bank2BankPayout"},{"$ref":"#/components/schemas/EPayPayout"},{"$ref":"#/components/schemas/EasyPayPayout"},{"$ref":"#/components/schemas/NetellerPayout"},{"$ref":"#/components/schemas/OttPayout"},{"$ref":"#/components/schemas/PayInReference"},{"$ref":"#/components/schemas/PayPalPayout"},{"$ref":"#/components/schemas/PayoutCard"},{"$ref":"#/components/schemas/PaysafecardPayout"},{"$ref":"#/components/schemas/PspToken"},{"$ref":"#/components/schemas/SkrillPayout"},{"$ref":"#/components/schemas/Tokenized"},{"$ref":"#/components/schemas/TrueLayerPayout"},{"$ref":"#/components/schemas/TrustlyPayout"}],"discriminator":{"propertyName":"type","mapping":{"accessWorldpay":"#/components/schemas/AccessWorldpayBankPayout","astroPay":"#/components/schemas/AstroPayPayout","bank2bank":"#/components/schemas/Bank2BankPayout","card":"#/components/schemas/PayoutCard","ePay":"#/components/schemas/EPayPayout","easyPay":"#/components/schemas/EasyPayPayout","neteller":"#/components/schemas/NetellerPayout","ottPayout":"#/components/schemas/OttPayout","payInReference":"#/components/schemas/PayInReference","paypal":"#/components/schemas/PayPalPayout","paysafecard":"#/components/schemas/PaysafecardPayout","pspToken":"#/components/schemas/PspToken","skrill":"#/components/schemas/SkrillPayout","tokenized":"#/components/schemas/Tokenized","trueLayer":"#/components/schemas/TrueLayerPayout","trustly":"#/components/schemas/TrustlyPayout"}},"example":{"type":"tokenized","token":"90289ce4-e0eb-48ca-8f8c-d2793eef387e"}},"GetPayoutResponseList":{"description":"Payouts matching the get payouts request","type":"array","items":{"$ref":"#/components/schemas/GetPayoutResponse"}},"GetPayoutResponse":{"description":"Information about a Payout transaction","type":"object","allOf":[{"$ref":"#/components/schemas/TransactionStatusBase"},{"type":"object","required":["status","paymentInstrument","merchantTransactionId","amount","currencyCode"],"properties":{"status":{"$ref":"#/components/schemas/PayoutStatus"},"paymentInstrument":{"$ref":"#/components/schemas/PayoutStatusPaymentInstrument"},"payoutEligibility":{"$ref":"#/components/schemas/PayoutEligibility"},"reference":{"type":"string","description":"Merchant provided reference for this payout\n","example":"payment-abc"},"cashierId":{"$ref":"#/components/schemas/CashierId"},"merchantTransactionId":{"$ref":"#/components/schemas/MerchantTransactionId"},"amount":{"title":"amount","type":"integer","format":"int64","minimum":0,"maximum":999999999999999,"example":1234,"description":"The amount provided in the initial request.\nThis will be in the lowest denomination of the currency.\nThis means that `1234` in GBP represents `£12.34`.\n"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"recipient":{"$ref":"#/components/schemas/GetPayoutResponseRecipient"},"blockingRule":{"$ref":"#/components/schemas/BlockingRule"},"pspProcessingMethod":{"$ref":"#/components/schemas/PspProcessingMethod"}}}]},"PayoutStatusResponse":{"type":"object","allOf":[{"$ref":"#/components/schemas/TransactionStatusBase"},{"type":"object","required":["status","paymentInstrument","amount","currencyCode"],"properties":{"status":{"$ref":"#/components/schemas/PayoutStatus"},"paymentInstrument":{"$ref":"#/components/schemas/PayoutStatusPaymentInstrument"},"payoutEligibility":{"$ref":"#/components/schemas/PayoutEligibility"},"reference":{"type":"string","description":"Merchant provided reference for this payout\n","example":"payment-abc"},"riskAssessments":{"$ref":"#/components/schemas/PayoutRiskAssessments"},"cashierId":{"$ref":"#/components/schemas/CashierId"},"customMetadata":{"$ref":"#/components/schemas/CustomMetadata"},"keyIdentifiers":{"$ref":"#/components/schemas/KeyIdentifiers"},"amount":{"title":"amount","type":"integer","format":"int64","minimum":0,"maximum":999999999999999,"example":1234,"description":"The amount provided in the initial request.\nThis will be in the lowest denomination of the currency.\nThis means that `1234` in GBP represents `£12.34`.\n"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"recipient":{"$ref":"#/components/schemas/GetPayoutResponseRecipient"},"blockingRule":{"$ref":"#/components/schemas/BlockingRule"},"pspProcessingMethod":{"$ref":"#/components/schemas/PspProcessingMethod"}}}]},"GetPayoutResponseRecipient":{"type":"object","properties":{"email":{"type":"string","description":"Email address of the customer.","minLength":1,"maxLength":254,"pattern":"^$|^[a-zA-Z0-9._%'+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$","example":"john.smith@example.com"},"phoneNumber":{"$ref":"#/components/schemas/PhoneNumber"}}},"CustomerOrderCode":{"description":"You may provide your own order code to be used in payments This is separate from the BR-DGE order.\nPlease use only letters, numbers, spaces and these symbols: `'[]()@?!\\-/.,_&*:;+=`\n","type":"string","minLength":1,"maxLength":50,"example":"ABC123"},"CustomerRefundCode":{"description":"You may provide your own code to be used in refunds, which will be provided to the PSP if it is supported.\nEach PSP may have different validation requirements for this code.\n","type":"string","maxLength":255,"example":"ABC123"},"PayPalOrderRequest":{"type":"object","required":["amount","currencyCode"],"description":"Create PayPal Order request","properties":{"amount":{"$ref":"#/components/schemas/Amount"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"intent":{"type":"string","default":"capture","description":"By default payments against an order will be captured in a single step, but you can choose to split the authorization and the capture of the order.\n * `authorize` - if you intend to first authorize using\n   `POST /paypal/orders/{orderId}/payments` with an intent of `authorize`\n   then capture the authorized payment using\n   `POST /paypal/orders/{orderId}/payments` with an intent of `capture`\n * `capture` - If you intend to capture immediately using\n   `POST /paypal/orders/{orderId}/payments` with an intent of `capture`\n","enum":["authorize","capture"]},"customerOrderCode":{"allOf":[{"$ref":"#/components/schemas/CustomerOrderCode"}],"description":"Merchant provided unique identifier for the order.\n\nPlease use only letters, numbers, spaces and these symbols: `'[]()@?!\\-/.,_&*:;+=`\n","maxLength":255},"displayName":{"description":"Business name which overrides the name in the PayPal account.\n\nPlease use only letters, numbers, spaces and these symbols: `'[]()@?!\\-/.,_&*:;+=`\n","type":"string","minLength":1,"maxLength":255,"example":"Display Name"},"locale":{"type":"string","example":"en-GB","description":"The locale used during PayPal payment (BCP 47)."},"invoiceId":{"description":"Merchant provided invoice number for the order.\n\nPlease use only letters, numbers, spaces and these symbols: `'[]()@?!\\-/.,_&*:;+=`\n","type":"string","minLength":1,"maxLength":255,"example":"987654321"},"vault":{"type":"boolean","example":true,"description":"Requests for the user's PayPal wallet to be vaulted by PayPal. If the customer agrees when\nredirected to PayPal, and if the payment is successful, a vaultId will be made available.\nThis is false by default.\n"},"returnUrl":{"type":"string","description":"The URL to return the customer to upon successful approval of a payment on the PayPal site.\nMandatory if vaulting is requested.\n"},"cancelUrl":{"type":"string","description":"The URL to return the customer to upon cancellation of the request on the PayPal site.\nMandatory if vaulting is requested.\n"},"enableShippingAddress":{"type":"boolean","example":true,"description":"Dictates display of shipping address selection during PayPal payment. If an address is\nsupplied in shippingAddressOverride it will be displayed regardless of the value of this field.\n"},"shippingAddressEditable":{"type":"boolean","example":false,"description":"Dictates display of shipping address selection during PayPal payment regardless of if a\nshipping address override is present.\n"},"shippingAddressOverride":{"$ref":"#/components/schemas/ShippingAddressOverride"},"lineItems":{"$ref":"#/components/schemas/LineItemsList"},"customer":{"$ref":"#/components/schemas/PayPalCustomer"},"ota":{"$ref":"#/components/schemas/PayPalOnlineTravelAgency"},"cashierId":{"$ref":"#/components/schemas/CashierId"},"customMetadata":{"$ref":"#/components/schemas/CustomMetadata"},"riskInstruments":{"$ref":"#/components/schemas/RiskInstruments"},"customerId":{"$ref":"#/components/schemas/CustomerId"},"customerIpAddress":{"$ref":"#/components/schemas/IpAddress"},"vaultId":{"$ref":"#/components/schemas/VaultId"}}},"PayPalOrderResponse":{"allOf":[{"$ref":"#/components/schemas/ComcardeResponse"},{"type":"object","description":"Create PayPal Order response.","properties":{"orderId":{"description":"The ID of the order.\n\nShould only contain letters, numbers, spaces and these symbols: `'[]()@?!\\-/.,_&*:;+=`\n","type":"string","minLength":1,"maxLength":255,"example":"987654321"},"status":{"type":"string","example":"CAPTURED","description":"The status of the order."},"redirectUrl":{"type":"string","example":"987654321","description":"The URL to redirect your customer to to progress the order."},"intent":{"type":"string","default":"capture","description":"By default payments against an order will be captured in a single step, but you can choose to split the authorization and the capture of the order.\n * `authorize` - if you intend to first authorize using\n   `POST /paypal/orders/{orderId}/payments` with an intent of `authorize`\n   then capture the authorized payment using\n   `POST /paypal/orders/{orderId}/payments` with an intent of `capture`\n * `capture` - If you intend to capture immediately using\n   `POST /paypal/orders/{orderId}/payments` with an intent of `capture`\n","enum":["authorize","capture"]},"creationTimestamp":{"type":"string","description":"The date and time that the order was created","example":"2022-01-30T10:10:10Z"},"riskAssessments":{"$ref":"#/components/schemas/PayPalOrderRiskAssessments"},"cashierId":{"$ref":"#/components/schemas/CashierId"},"psp":{"$ref":"#/components/schemas/PspInfo"},"paymentId":{"type":"string","description":"The ID of the payment associated with this Order.","example":"57f7f444-29ce-4230-8c7f-1c1fd85c8bc9"}}}]},"PayPalOrder":{"type":"object","description":"Get PayPal Order status response.","properties":{"orderId":{"type":"string","example":"1000","minLength":1,"maxLength":255,"pattern":"^([\\p{L}\\p{M} 0-9'\\[\\]()@?!\\-/.,_&*:;+=\\r\\n]*)$","description":"The ID for the order."},"intent":{"type":"string","example":"capture","description":"Intent of the Order.","enum":["authorize","capture"]},"status":{"type":"string","example":"CAPTURED","description":"The status of the order."},"creationTimestamp":{"type":"string","description":"The date and time that the order was created.","example":"2022-01-30T10:10:10Z"},"paymentSource":{"$ref":"#/components/schemas/PaymentSource"},"purchaseUnits":{"type":"array","items":{"$ref":"#/components/schemas/PurchaseUnit"}},"psp":{"$ref":"#/components/schemas/PspInfo"},"paymentId":{"type":"string","description":"The ID of the payment associated with this Order.","example":"57f7f444-29ce-4230-8c7f-1c1fd85c8bc9"}}},"PayPalOrderPaymentRequest":{"type":"object","description":"Complete payment for PayPal Order request.","properties":{"intent":{"type":"string","default":"capture","description":"By default payments are captured immediately, but you can you can choose to split the authorization and the capture of the payment.\n * `authorize` - if you intend to capture separately using\n   `POST /payments/{paymentId}/capture`\n * `capture` - If you intend to capture immediately\n","enum":["authorize","capture"]}}},"PayPalOrderPaymentResponse":{"allOf":[{"$ref":"#/components/schemas/ComcardeResponse"},{"type":"object","description":"Complete payment for PayPal Order response.","properties":{"paymentId":{"type":"string","description":"The ID of this payment.","example":"57f7f444-29ce-4230-8c7f-1c1fd85c8bc9"},"orderId":{"type":"string","example":"987654321","minLength":1,"maxLength":255,"pattern":"^([\\p{L}\\p{M} 0-9'\\[\\]()@?!\\-/.,_&*:;+=\\r\\n]*)$","description":"The ID of the order."},"status":{"type":"string","example":"CAPTURED","description":"The status of the order."},"amount":{"$ref":"#/components/schemas/Amount"},"psp":{"$ref":"#/components/schemas/PspInfo"},"account":{"$ref":"#/components/schemas/PaymentInstrumentAccountBase"}}}]},"ShippingAddressOverride":{"type":"object","description":"Details of the destination to ship the items too.","properties":{"address1":{"$ref":"#/components/schemas/AddressLineOne"},"address2":{"$ref":"#/components/schemas/AddressLineTwo"},"town":{"$ref":"#/components/schemas/Town"},"county":{"$ref":"#/components/schemas/County"},"postcode":{"$ref":"#/components/schemas/Postcode"},"country":{"$ref":"#/components/schemas/CountryIsoCode"},"phoneNumber":{"$ref":"#/components/schemas/PhoneNumber"},"buildingNumberOrName":{"$ref":"#/components/schemas/BuildingNumberOrName"},"recipientName":{"description":"Full name of the recipient.\n\nPlease use only letters, numbers, spaces and these symbols: `'[]()@?!\\-/.,_&*:;+=`\n","type":"string","minLength":1,"maxLength":255,"example":"John Smith"}}},"LineItemsList":{"type":"array","items":{"$ref":"#/components/schemas/LineItem"}},"LineItem":{"type":"object","description":"Details of the item being purchased.","properties":{"name":{"description":"Name of the item.\n\nPlease use only letters, numbers, spaces and these symbols: `'[]()@?!\\-/.,_&*:;+=`\n","type":"string","minLength":1,"maxLength":255,"example":"T-Shirt"},"description":{"description":"Description of the item.\n\nPlease use only letters, numbers, spaces and these symbols: `'[]()@?!\\-/.,_&*:;+=`\n","type":"string","minLength":1,"maxLength":255,"example":"A green t-shirt"},"quantity":{"type":"integer","example":1,"format":"int64","minimum":1,"maximum":999999999999999,"description":"Number of the item ordered."},"unitAmount":{"type":"integer","example":1000,"format":"int64","minimum":1,"maximum":999999999999999,"description":"Amount per unit."},"unitTax":{"type":"integer","example":100,"format":"int64","minimum":1,"maximum":999999999999999,"description":"Item tax per unit."}}},"PayPalAccountId":{"type":"string","description":"PayPal Account ID of the customer.","maxLength":255,"example":"G83JXTJ5EHCQ2"},"PayPalCustomer":{"type":"object","description":"Customer's account details with the merchant.","properties":{"accountId":{"description":"Customer's account ID with the merchant.\n\nPlease use only letters, numbers, spaces and these symbols: `'[]()@?!\\-/.,_&*:;+=`\n","type":"string","minLength":1,"maxLength":255,"example":"A12345N343"},"firstName":{"description":"Customer's first name.\n\nPlease use only letters, numbers, spaces and these symbols: `'[]()@?!\\-/.,_&*:;+=`\n","type":"string","minLength":1,"maxLength":50,"example":"John"},"lastName":{"description":"Customer's last name.\n\nPlease use only letters, numbers, spaces and these symbols: `'[]()@?!\\-/.,_&*:;+=`\n","type":"string","minLength":1,"maxLength":50,"example":"Smith"},"email":{"type":"string","description":"Email address of the customer.","minLength":1,"maxLength":254,"pattern":"^$|^[a-zA-Z0-9._%'+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$","example":"john.smith@example.com"},"phoneNumber":{"$ref":"#/components/schemas/PhoneNumber"},"country":{"$ref":"#/components/schemas/CountryIsoCode"},"creationTimestamp":{"type":"string","description":"The date and time that the customers' account was created.","example":"2022-01-30T10:10:10Z"}}},"PayPalOnlineTravelAgency":{"type":"object","description":"Details of the booked transportation. Only required if you're an online travel agency.","properties":{"type":{"type":"string","example":"bus","description":"The type of transportation the customer has booked.","enum":["hotel","train","ferry","bus","multimodal","airline"]},"serviceStartDate":{"type":"string","example":"2022-01-30T10:10:10Z","description":"The start date of the transport."},"serviceEndDate":{"type":"string","example":"2022-01-30T10:10:10Z","description":"The end date of the transport."},"changeGuest":{"type":"boolean","example":false,"description":"Whether the customer associated with the booking can change."},"startCountry":{"type":"string","example":"GB","description":"The starting country of the transportation."},"startCity":{"description":"The starting city of the transportation.\n\nPlease use only letters, numbers, spaces and these symbols: `'[]()@?!\\-/.,_&*:;+=`\n","type":"string","minLength":1,"maxLength":50,"example":"Edinburgh"},"startPostcode":{"description":"The starting postcode of the transportation.\n\nPlease use only letters, numbers, spaces and these symbols: `'[]()@?!\\-/.,_&*:;+=`\n","type":"string","maxLength":255,"example":"BH23 6AA"}}},"PaymentSource":{"type":"object","description":"Details of the PayPal account used to complete the payment for the PayPal Order.","properties":{"name":{"type":"string","example":"John Smith","minLength":1,"maxLength":255,"pattern":"^([\\p{L}\\p{M} 0-9'\\[\\]()@?!\\-/.,_&*:;+=\\r\\n]*)$","description":"Full name of customer."},"email":{"type":"string","description":"Email address of the customer.","minLength":1,"maxLength":254,"pattern":"^$|^[a-zA-Z0-9._%'+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$","example":"john.smith@example.com"},"accountId":{"type":"string","example":"QYR5Z8XDVJNXQ","minLength":1,"maxLength":255,"pattern":"^([\\p{L}\\p{M} 0-9'\\[\\]()@?!\\-/.,_&*:;+=\\r\\n]*)$","description":"PayPal account ID."},"vaultId":{"$ref":"#/components/schemas/VaultId"}}},"VaultId":{"type":"string","example":"0tb28273r6584005e","minLength":1,"maxLength":255,"description":"Vault ID generated by PayPal referring to the customer's stored PayPal wallet."},"PurchaseUnit":{"type":"object","description":"Item purchase as part of a PayPal order.","properties":{"referenceId":{"type":"string","example":"1000","minLength":1,"maxLength":255,"pattern":"^([\\p{L}\\p{M} 0-9'\\[\\]()@?!\\-/.,_&*:;+=\\r\\n]*)$","description":"Merchant provided unique identifier for the purchased item."},"description":{"type":"string","example":"1000","minLength":1,"maxLength":255,"pattern":"^([\\p{L}\\p{M} 0-9'\\[\\]()@?!\\-/.,_&*:;+=\\r\\n]*)$","description":"Description of the item."},"customId":{"type":"string","example":"123456789","minLength":1,"maxLength":255,"pattern":"^([\\p{L}\\p{M} 0-9'\\[\\]()@?!\\-/.,_&*:;+=\\r\\n]*)$","description":"Merchant provided unique identifier for the order."},"invoiceId":{"type":"string","example":"987654321","minLength":1,"maxLength":255,"pattern":"^([\\p{L}\\p{M} 0-9'\\[\\]()@?!\\-/.,_&*:;+=\\r\\n]*)$","description":"Merchant provided invoice number for the order."},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"unitAmount":{"type":"integer","format":"int64","minimum":1,"maximum":999999999999999,"example":1000,"description":"Amount per unit."},"unitTax":{"type":"integer","format":"int64","minimum":1,"maximum":999999999999999,"example":100,"description":"Item tax per unit."}}},"CustomMetadata":{"title":"Custom Metadata for the transaction.","description":"Optional custom metadata string fields for the transaction.\n\nUp to 25 fields can be included with the following constraints:\n\nThe field name may not be empty or have leading or trailing whitespace, and can consist of upper and lowercase letters, numbers, space, underscore \"_\", hyphen \"-\" and single quote \"'\".\n\nMaximum string length of either field name and field value is 200 chars.\n","type":"object","additionalProperties":{"type":"string","maxLength":200,"nullable":false},"maxProperties":25,"example":{"accountAge":"2","transactionType":"Other"}},"BuildingNumberOrName":{"description":"The building number or name.\n\nProviding a building number or name separate from `address1` is recommended as\nsome payment service provider (PSP) APIs have a separate field.\n\nIf you are unsure whether you need to collect this data, please raise a\nticket with support on the BR-DGE Support Portal at\n<https://docs.br-dge.io/docs/support#contact-support>.\n\nPlease use only letters, spaces and these symbols: `-'.`","type":"string","maxLength":100,"example":"10a"},"AddressLineOne":{"description":"First line of the address.\n\nPlease use only letters, numbers, spaces and these symbols: `'[]()@?!\\-/.,_&*:;+=`","type":"string","minLength":1,"maxLength":255,"example":"Flat 1"},"AddressLineTwo":{"description":"Second line of the address.\n\nPlease use only letters, numbers, spaces and these symbols: `'[]()@?!\\-/.,_&*:;+=`","type":"string","maxLength":255,"example":"Victoria House"},"AddressLineThree":{"description":"Third line of the address.\n\nPlease use only letters, numbers, spaces and these symbols: `'[]()@?!\\-/.,_&*:;+=`","type":"string","maxLength":255,"example":"15 Apple Street"},"Town":{"description":"Town of the address.\n\nPlease use only letters, numbers, spaces and these symbols: `'[]()@?!\\-/.,_&*:;+=`","type":"string","minLength":1,"maxLength":255,"example":"Edinburgh"},"County":{"description":"County of the address.\n\nPlease use only letters, numbers, spaces and these symbols: `'[]()@?!\\-/.,_&*:;+=`","type":"string","maxLength":255,"example":"Lothian"},"Postcode":{"description":"Postcode of the address.\n\nPlease use at least one and no more than 9 alphanumeric characters (excl. spaces).","type":"string","maxLength":255,"example":"BH23 6AA"},"PhoneNumber":{"maxLength":255,"pattern":"^$|^[+]?[(0-9][0-9 ()-]*[0-9]$","type":"string","description":"Telephone number of the occupant\nPlease use only numbers, spaces and an optional leading +.","example":"+44 123 1110000"},"CvvResult":{"title":"CVV Result","type":"object","description":"Information about the CVV (Card Verification Value) result.\n","properties":{"code":{"type":"string","enum":["M","N","S","P","C","U","X","Z"],"description":"The CVV (Card Verification Value) result code.\n\n| CVV Code | Meaning                            |\n|----------|------------------------------------|\n| M        | Match                              |\n| N        | No Match                           |\n| S        | Not Supplied                       |\n| P        | Not Processed                      |\n| C        | Not Sent                           |\n| U        | Issuer Not Certified               |\n| X        | No Response / Provider Unavailable |\n| Z        | Unknown                            |\n","example":"M"}}},"AvsResult":{"title":"AVS Result","type":"object","description":"Information about the AVS (Address Verification Service) result.\n","properties":{"code":{"type":"string","enum":["A","B","C","D","E","F","G","H","I","J","K","L","M","N","O","P","Q"],"description":"The AVS (Address Verification Service) result code.\n\n| AVS Code | Meaning                                                       |\n|----------|---------------------------------------------------------------|\n| A        | Postal code matches, street address matches.                  |\n| B        | Postal code matches, street address not checked.              |\n| C        | Postal code matches, street address does not match.           |\n| D        | Postal code not checked, street address matches.              |\n| E        | Postal code does not match, street address matches.           |\n| F        | Postal code not checked, street address not checked.          |\n| G        | Postal code not checked, street address does not match.       |\n| H        | Postal code does not match, street address not checked.       |\n| I        | Both postal code and street address do not match.             |\n| J        | Both postal code and street address were not provided.        |\n| K        | AVS is unavailable.                                           |\n| L        | Postal code was not provided, street address was not checked. |\n| M        | Postal code was not provided, street address matches.         |\n| N        | Postal code was not provided, street address does not match.  |\n| O        | Postal code was not checked, street address was not provided. |\n| P        | Postal code matches, street address was not provided.         |\n| Q        | Postal code does not match, street address was not provided.  |\n","example":"I"},"message":{"type":"string","description":"A human readable meaning behind the AVS code specified in the `code` field.\n"}}},"ScaDetails":{"type":"object","description":"Contains Strong Customer Authentication (SCA) details about the outcome of any 3DS process the payment went through.\n\nNote: this field is now deprecated, and `authentication.result.eci` should be used instead.\n","deprecated":true,"properties":{"eci":{"$ref":"#/components/schemas/Eci"}}},"Eci":{"type":"string","example":"05","description":"The Electronic Commerce Indicator (ECI) value that indicates the 3DS authentication level","pattern":"^[0-9]+$","minLength":2,"maxLength":2},"Authentication":{"type":"object","description":"3-D Secure details for the payment. `result` is only returned once the payment status is not `AUTHORIZATION_PENDING`.\n","properties":{"requested":{"$ref":"#/components/schemas/AuthenticationRequested"},"result":{"$ref":"#/components/schemas/AuthenticationResult"}}},"AuthenticationRequested":{"type":"object","description":"The 3-D Secure options requested for the payment.","properties":{"threeDSecureRequired":{"type":"boolean","description":"Whether 3-D Secure was requested.","example":true},"challengeRequested":{"type":"boolean","description":"Whether a 3-D Secure challenge was requested.","example":false},"automaticallyStepUp":{"type":"boolean","description":"Whether the payment was set to retry with 3-D Secure if the PSP asked for it.","example":false}}},"AuthenticationResult":{"type":"object","description":"The outcome of 3-D Secure authentication, as reported by the PSP.","properties":{"enrollmentStatus":{"type":"string","enum":["ENROLLED","NOT_ENROLLED","UNKNOWN"],"description":"Whether the card is enrolled in 3-D Secure.\n\n| Value        | Meaning                                                 |\n|--------------|---------------------------------------------------------|\n| ENROLLED     | The card is enrolled in 3-D Secure.                     |\n| NOT_ENROLLED | The card is not enrolled in 3-D Secure.                 |\n| UNKNOWN      | The PSP could not confirm whether the card is enrolled. |\n","example":"ENROLLED"},"transStatus":{"type":"string","enum":["Y","N","U","A","C","D","R","I","S"],"description":"The 3-D Secure authentication status, as defined by EMVCo.\n\n| Status | Meaning                                                   |\n|--------|-----------------------------------------------------------|\n| Y      | Authentication successful.                                |\n| N      | Not authenticated. Transaction denied.                    |\n| U      | Authentication could not be performed.                    |\n| A      | Attempts processing performed. Proof of attempt provided. |\n| C      | Challenge required.                                       |\n| D      | Challenge required. Decoupled authentication confirmed.   |\n| R      | Authentication rejected. Do not attempt authorisation.    |\n| I      | Informational only. Challenge preference acknowledged.    |\n| S      | Challenge using Secure Payment Confirmation (SPC).        |\n","example":"Y"},"flow":{"type":"string","enum":["FRICTIONLESS","CHALLENGE"],"description":"Whether the cardholder was challenged.\n\n| Value        | Meaning                                                  |\n|--------------|----------------------------------------------------------|\n| FRICTIONLESS | Authentication completed without a cardholder challenge. |\n| CHALLENGE    | The cardholder was challenged.                           |\n","example":"FRICTIONLESS"},"version":{"type":"string","description":"The 3-D Secure version used.","example":"2.2.0"},"eci":{"$ref":"#/components/schemas/Eci"}}},"AuthorizationCode":{"type":"string","description":"The code provided by the PSP in response to a successfully authorized payment.","example":"123456"},"BlockingRule":{"description":"The routing rule which resulted in the transaction being blocked.","type":"object","required":["name"],"properties":{"name":{"description":"The name of the rule","type":"string"}}},"MerchantTransactionId":{"type":"string","description":"Your unique identifier that can be used when a connection issue occurs and you don't receive a paymentId. This is an optional field that can be used when querying `GET v1/payments`, `GET v1/payouts` or `GET v1/payments/{paymentId}/refunds`. We will validate the uniqueness of the merchantTransactionId value per retail channel. If a payment/payout/refund is created with merchantTransactionId `abc`, no other payment/payout/refund can be created with `abc`.\n\nThe merchantTransactionId is a contract between BR-DGE and a merchant. This field will not be mapped downstream to any PSP.\n\nIn the event that you provide a merchantTransactionId in the second (or third) leg of a 3DS payment, we will ignore this value and will only use the value provided in the initial request.","example":"yourUniqueRequestId","minLength":1,"maxLength":50},"CustomerId":{"title":"Customer ID","description":"The ID of the customer in your system.\n\nPlease use only letters, numbers, spaces and these symbols: `'[]()@?!\\-/.,_&*:;+=`\n","type":"string","maxLength":255,"example":"Customer001"},"PspName":{"description":"Name of Payment Service Provider (PSPs).\n\nPlease see [PSP Integrations] for a list of possible PSPs.\n\n[PSP Integrations]: https://docs.br-dge.io/docs/psp-integrations\n","type":"string","pattern":"^[A-Za-z0-9\\- ().]*$","maxLength":50,"example":"Checkout.com"},"IpAddress":{"pattern":"^$|^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}|(([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|::(ffff(:0{1,4})?:)?((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))$","type":"string","description":"IP address of the customer (IPv4 or IPv6)","example":"123.100.100.200"},"PaysafecardAdditionalInfo":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `AdditionalInfo` schema."},"customerFirstName":{"type":"string","description":"Customer's first name","example":"John"},"customerLastName":{"type":"string","description":"Customer's last name","example":"Smith"},"customerDateOfBirth":{"type":"string","format":"date","description":"Customer's date of birth","example":"2000-01-01"},"customerIpAddress":{"$ref":"#/components/schemas/IpAddress"},"customerId":{"type":"string","description":"The ID of the customer in your system.","example":"de5d7b4a-9410-40e1-85fd-8ceee23c9fd0"},"paysafecardCustomerId":{"type":"string","description":"Paysafecard identifier for the customer","example":"151743187547"}}},"EasyPayAdditionalInfo":{"required":["type"],"allOf":[{"type":"object","properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `AdditionalInfo` schema.","example":"EasyPay"},"customerPaymentOptionId":{"type":"string","description":"Identifier for the customer Payment Option","example":"6418da68-0b3d-4409-ab14-1ceb752b0b1f"}}}]},"ePayBgAdditionalInfo":{"required":["type"],"allOf":[{"type":"object","properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `AdditionalInfo` schema.","example":"ePay.bg"},"customerPaymentOptionId":{"type":"string","description":"Identifier for the customer Payment Option","example":"6418da68-0b3d-4409-ab14-1ceb752b0b1f"}}}]},"TrueLayerCustomer":{"type":"object","description":"Contains TrueLayer customer information.\n","properties":{"address":{"$ref":"#/components/schemas/Address"},"dateOfBirth":{"$ref":"#/components/schemas/DateOfBirth"},"customerId":{"type":"string","description":"The ID of the customer in TrueLayer's system","example":"de5d7b4a-9410-40e1-85fd-8ceee23c9fd0"},"name":{"type":"string","description":"Customer's full name","example":"John Smith"}}},"AccountNumber":{"type":"string","description":"8 digit bank account number.","example":"26207729","pattern":"^[0-9]{8}$"},"SortCode":{"type":"string","description":"6 digit sort code (no spaces or dashes).","example":"400040","pattern":"^[0-9]{6}$"},"Iban":{"type":"string","description":"Valid ISO 13616 International Bank Account Number (no spaces). Consists of a 2 letter country code, followed by 2 check digits, and then by up to 30 alphanumeric characters (also known as the BBAN).\n","example":"GB32CLRB04066800012315","minLength":15,"maxLength":34,"pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,30}$"},"TrueLayerAdditionalInfo":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `AdditionalInfo` schema."},"customer":{"$ref":"#/components/schemas/TrueLayerCustomer"},"providerId":{"type":"string","description":"ID of the bank or other financial institution used in this payment in TrueLayer's system","example":"mock-payments-gb-redirect"},"paymentSourceId":{"type":"string","description":"ID of the customer's payment source used to perform the payment in TrueLayer's system","example":"1f111d3c-9427-43be-1111-1111219d111c"},"originalTransactionId":{"type":"string"},"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"sortCode":{"$ref":"#/components/schemas/SortCode"},"iban":{"$ref":"#/components/schemas/Iban"}}},"RevolutFingerprint":{"type":"string","minLength":44,"maxLength":44,"description":"The fingerprint associated to the authorized order's payment method","example":"AoJYD3lVDidRE9RyUHDGmKakQ8lpDnSMtRFUjqyLzZU="},"RevolutPayBillingAddress":{"type":"object","properties":{"street_line_1":{"type":"string","maxLength":100,"description":"First line of street address information for Revolut customer."},"street_line_2":{"type":"string","maxLength":100,"description":"Second line of street address information for Revolut customer.."},"region":{"type":"string","maxLength":100,"description":"The region associated with the address."},"city":{"type":"string","maxLength":100,"description":"The region associated with the address."},"country_code":{"type":"string","maxLength":2,"description":"2 letter country code of the country associated with the address."},"postcode":{"type":"string","maxLength":100,"description":"The postcode associated with the address."}}},"RevolutPayAdditionalInfo":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `AdditionalInfo` schema."},"fingerprint":{"$ref":"#/components/schemas/RevolutFingerprint"},"name":{"type":"string","minLength":2,"description":"The name of the revolut customer.","example":"Jimmy McShuggle"},"emailAddress":{"type":"string","minLength":2,"description":"The email address of the revolut customer","example":"jim@test.com"},"paymentRevTag":{"type":"string","minLength":2,"description":"Unique handle for a Revolut customer.","example":"xyzed7xn"},"revolutCustomerId":{"type":"string","format":"uuid","description":"The unique identifier for the revolut customer.","example":"44773429-8b07-4973-b9de-3d308e86b955"},"billingAddress":{"$ref":"#/components/schemas/RevolutPayBillingAddress"}}},"PayPalAdditionalInfo":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `AdditionalInfo` schema."},"vaultId":{"$ref":"#/components/schemas/VaultId"},"paymentSource":{"$ref":"#/components/schemas/PaymentSource"}}},"OttPayoutsAdditionalInfo":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `AdditionalInfo` schema."},"pin":{"type":"string","description":"voucher pin","maxLength":12,"pattern":"^[0-9]*$","example":"464828964739"},"serialNumber":{"type":"string","description":"voucher serial number","maxLength":12,"pattern":"^[0-9]*$","example":"300003849616"}}},"AdditionalInfo":{"type":"object","description":"Any additional information returned from interaction with PSP","oneOf":[{"$ref":"#/components/schemas/PaysafecardAdditionalInfo"},{"$ref":"#/components/schemas/EasyPayAdditionalInfo"},{"$ref":"#/components/schemas/ePayBgAdditionalInfo"},{"$ref":"#/components/schemas/TrueLayerAdditionalInfo"},{"$ref":"#/components/schemas/RevolutPayAdditionalInfo"},{"$ref":"#/components/schemas/PayPalAdditionalInfo"},{"$ref":"#/components/schemas/OttPayoutsAdditionalInfo"}],"discriminator":{"propertyName":"type","mapping":{"paysafecard":"#/components/schemas/PaysafecardAdditionalInfo","EasyPay":"#/components/schemas/EasyPayAdditionalInfo","ePayBg":"#/components/schemas/ePayBgAdditionalInfo","truelayer":"#/components/schemas/TrueLayerAdditionalInfo","revolutPay":"#/components/schemas/RevolutPayAdditionalInfo","payPal":"#/components/schemas/PayPalAdditionalInfo","ottPayout":"#/components/schemas/OttPayoutsAdditionalInfo"}}},"RawResponse":{"description":"Contains a single http response.\n","type":"object","properties":{"httpStatusCode":{"description":"The http response code for the given call to the external system\n","type":"integer","example":200},"body":{"description":"The response body of the http request to the external system. This is the raw response with sensitive data redacted.  We make no guarantees about the format of this field. It is psp dependant. The majority of these responses are in `application/json` but note for certain types of error response they may be `text/html` or `application/xml`\n","type":"string"}}},"RawPspResponse":{"allOf":[{"$ref":"#/components/schemas/RawResponse"},{"description":"Contains a single http response from the PSP the transaction was routed to\n","type":"object","required":["pspName"],"properties":{"pspName":{"$ref":"#/components/schemas/PspName"},"headers":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"description":"A key/value map of the http headers from the external system.","example":{"content-type":["application/json"]}}}}]},"PspInfo":{"type":"object","required":["name","transactionId"],"properties":{"name":{"$ref":"#/components/schemas/PspName"},"transactionId":{"type":"string","description":"Identifier provided by the PSP this payment was routed to.\n","example":"6418da68-0b3d-4409-ab14-1ceb752b0b1f"},"switchAccountId":{"type":"string","description":"Internal switch account identifier for the PSP account that was used to perform the transaction. This is an internally-assigned identifier, not a value provided by the PSP.\nPlease note: PSP account switching feature is still under development and this field is not present in GET responses and notifications yet.\n","minLength":1,"maxLength":255,"example":"switch-account-123"},"pspToken":{"type":"string","description":"The token created by the PSP for the payment instrument.\n"},"pspCardFingerprint":{"type":"string","description":"The PSP fingerprint for the payment instrument.\n"},"provisionedUserId":{"type":"string","description":"PSP-specific user ID that was provisioned by the PSP when processing the payment.\n","example":"Vx0H4pdAtPCz"},"additionalInfo":{"$ref":"#/components/schemas/AdditionalInfo"},"rawPspResponses":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/RawPspResponse"}},"paymentAccountReference":{"type":"string","description":"The Payment Account Reference (PAR) linked the the payment-instrument, if available. See our [dedicated PAR guide](https://docs.br-dge.io/docs/payment-account-reference) for more info."}}},"RelationshipIdentifier":{"description":"An included relationship, will include the lookup information and the\nattributes related to that inclusion.\n","type":"object","required":["type","id"],"properties":{"id":{"description":"The identifier for the specified relation.","type":"string"},"type":{"description":"The resource type which is applicable for an entity.","type":"string"}}},"RelationshipEntity":{"description":"A schema which provides the relationships which are applicable for the\ncurrent entity.\n\nThese relationship entities particularly provide the information\nrequired to lookup entities which have been included in the request\nusing the pattern equivelent to [JSON:API Inclusion of Related\nResources].\n\n[JSON:API Inclusion of Related Resources]: https://jsonapi.org/format/1.1/#fetching-includes\n","type":"object","properties":{"relationships":{"description":"A map of a specified relation to the identifiable information for\nthat relation.\nThe key of the map is the requested relation information from the\ninclude parameter.\n","type":"object","additionalProperties":{"description":"The relationship details for a specific relation.\n\nThis provides the lookup information which can be used to find\nthe included component in `included` on the root of the\nresponse.\n","type":"object","properties":{"data":{"$ref":"#/components/schemas/RelationshipIdentifier"}}}}}},"CurrencyCodeNumeric":{"example":"826","type":"string","description":"ISO 4217 numeric currency code, as a string to preserve leading zeros"},"IncludedRelationshipsItemPaymentInstrument":{"allOf":[{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/PaymentResponsePaymentInstrument"}}},{"$ref":"#/components/schemas/RelationshipIdentifier"}]},"IncludedRelationshipsItemIssuerResponse":{"allOf":[{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/IssuerResponse"}}},{"$ref":"#/components/schemas/RelationshipIdentifier"}]},"IncludedRelationshipsItem":{"oneOf":[{"$ref":"#/components/schemas/IncludedRelationshipsItemPaymentInstrument"},{"$ref":"#/components/schemas/IncludedRelationshipsItemIssuerResponse"}],"discriminator":{"propertyName":"type","mapping":{"paymentInstrument":"#/components/schemas/IncludedRelationshipsItemPaymentInstrument","issuerResponse":"#/components/schemas/IncludedRelationshipsItemIssuerResponse"}}},"IncludedRelationships":{"description":"This returns a list of included relationships.\nThis should only be included on the root of the response.\n","type":"object","properties":{"included":{"description":"A list of included relationships, where applicable these can be\nincluded via the include parameter.\n\nThis conforms to [JSON:API Compound Documents].\n\n[JSON:API Compound Documents]: https://jsonapi.org/format/1.1/#document-compound-documents\n","type":"array","items":{"$ref":"#/components/schemas/IncludedRelationshipsItem"}}}},"TrustlyAccount":{"type":"object","description":"Contains Trustly account information.\n","properties":{"accountId":{"type":"string","description":"Trustly's unique ID for this bank account.","example":"1234567890"},"bank":{"type":"string","description":"The bank for this account.","example":"Barclays"},"town":{"type":"string","description":"The town of the account holder.","example":"PaloAlto"},"name":{"type":"string","description":"The name of the account holder.","example":"John Mockington"},"address":{"type":"string","description":"The address of the account holder.","example":"LincolnDrive"},"postcode":{"type":"string","description":"The postcode of the account holder.","example":"456"},"descriptor":{"type":"string","description":"A text that is safe to show the end user for identifying the account.","example":"**926819"},"lastDigits":{"type":"string","description":"The last digits of the bank account number.","example":"926819"},"clearingHouse":{"type":"string","description":"The clearing house of the end user's bank account (i.e. the country where the bank account is held).\n","example":"UNITED_KINGDOM"},"verified":{"type":"boolean","description":"Whether the bank account has been verified."}}},"CashierId":{"title":"Cashier ID","type":"string","description":"For use by BR-DGE Cashier to link the transaction to a particular Cashier instance.","example":"90e7aff7-7e57-459a-a46e-9258c8abc99b"},"PaymentRails":{"type":"string","example":"EFTPOS","description":"Payment rails are the systems and networks that are used to move funds between parties. Card networks can act as payment rails.\n\nThis field contains payment rails used for current payment.\n\n- EFTPOS - Australia's domestic debit card payments network\n- VISA - Visa international payment network\n- MASTERCARD - Mastercard international payment network\n","enum":["EFTPOS","VISA","MASTERCARD"]},"AmountIncludingZero":{"title":"amount","type":"integer","format":"int64","minimum":0,"maximum":999999999999999,"example":1234,"description":"Amount in a currency to be used for the transaction.\nIn the lowest denomination of the currency of the payment.\nThis means that `1234` in GBP represents `£12.34`.\n"},"CurrencyCode":{"type":"string","description":"Currency code of the payment (ISO 4217)","example":"GBP"},"ComcardeResponse":{"type":"object","properties":{"code":{"type":"string","description":"[Response Code](https://docs.br-dge.io/docs/response-codes) signifying the outcome of the request.","example":"1000"},"message":{"type":"string","description":"A description of the outcome of the request."},"id":{"type":"string","description":"The ID of this request. If you can include these when querying the outcome of individual requests, we can track down the root cause faster.\n","example":"463ac35c9f6413ad48485a3953bb6124"}}},"ErrorResponse":{"allOf":[{"$ref":"#/components/schemas/ComcardeResponse"},{"type":"object","properties":{"validationErrors":{"type":"object","additionalProperties":{"type":"string"},"description":"An object that contains validation errors."}}}]},"DuplicateMerchantTransactionIdError":{"description":"Indicates a request conflict.","required":["code","message","id","merchantTransactionId"],"allOf":[{"$ref":"#/components/schemas/ComcardeResponse"},{"type":"object","properties":{"merchantTransactionId":{"$ref":"#/components/schemas/MerchantTransactionId"}}}]},"BaseCallback":{"type":"object","required":["type","merchantAccountId","code","message","hashCode"],"properties":{"type":{"type":"string"},"merchantAccountId":{"type":"string","description":"Identifier of the merchant account associated with the payment\n","example":"00000000-0000-0000-0000-000000000000"},"code":{"type":"string","description":"[Response Code](https://docs.br-dge.io/docs/response-codes) signifying the outcome of the request","example":"1000"},"message":{"type":"string","description":"A description of the outcome"},"hashCode":{"type":"string","description":"Hash Code of select fields of the payload, used for authenticity checks.\n\nThe value in this field is a hashCode that can be used to verify that key fields in the notification message payload has not been tampered with and also to confirm that it has been sent from the BR-DGE platform.\n\nDetails can be found in [Notification Hashing] documentation.\n\n[Notification Hashing]: https://docs.br-dge.io/docs/notification-hashing\n"},"codeDescription":{"type":"string","description":"A short, human-readable statement describing the `code` field above.\nThis may be unpopulated depending on the value of `code`, and may be subject to change.\n","example":"Approved"}}},"PspInfoCallback":{"allOf":[{"$ref":"#/components/schemas/PspInfo"},{"type":"object","title":"PspInfoCallback","properties":{"message":{"type":"string","description":"Original message provided by PSP, if applicable."}}}]},"TransactionCallback":{"allOf":[{"$ref":"#/components/schemas/BaseCallback"},{"type":"object","required":["id","psp"],"properties":{"id":{"type":"string","description":"Unique identifier for the transaction","example":"2c6a34be-f7a1-4b49-b09c-e84e1322df7f"},"psp":{"$ref":"#/components/schemas/PspInfoCallback"}}}]},"PaymentStatusCallback":{"type":"string","description":"Status of the payment\n### `DECLINED`\nA transaction has been submitted for authorization to the processor and this request has been processed and declined. The transaction could have been declined by the processor due to rules within their system (fraud, velocity limits, value limits) or by the Card Issuer. There will be an associated “reason” assigned to this state providing details of the decline.\n### `REJECTED`\nA transaction has been submitted for authorization to the processor and this been rejected due to a validation or a technical error. This rejection can have occurred within the BR-DGE platform, the processor or the Card Issuer. There will be an associated “reason” assigned to this state providing details of the rejection.\n### `AUTHORIZATION_PENDING`\nA transaction has been submitted for authorization to the processor and this request has been accepted by the processor but the outcome has not been determined.\n### `AUTHORIZED`\nA transaction has been submitted for authorization to the processor and this request has been processed and authorized. The transaction is now available to be included in a Capture request. Where the merchant is enrolled for auto capture with the processor, the transaction status will be set directly to `CAPTURED`\n### `CAPTURE_PENDING`\nAn authorized transaction has been submitted for capture and this request has been accepted by the processor but the outcome has not been determined.\n### `CAPTURED`\nAn authorized transaction has been submitted for capture and this request has been accepted and confirmed by the processor.\n### `CAPTURE_FAILED`\nA transaction has been submitted for authorization to the processor and this request has been processed and failed. There will be an associated “reason” assigned to this state providing details of the failure.\n### `VOIDED`\nThe merchant has requested that a authorized transaction is cancelled / voided and the processor has accepted the void request.\n### `UNKNOWN`\nAlthough not expected to happen, this is used as a fallback in case no payment status is identified.\n","example":"CAPTURED","enum":["AUTHORIZED","DECLINED","AUTHORIZATION_PENDING","CAPTURED","CAPTURE_FAILED","CAPTURE_PENDING","EXPIRED","REJECTED","VOIDED","VOID_PENDING","VOID_FAILED","BLOCKED","UNKNOWN"]},"CustomerIdentifiers":{"type":"object","properties":{"customerId":{"$ref":"#/components/schemas/CustomerId"}}},"KeyIdentifierId":{"type":"string","description":"A unique id for a specific identifier, used in other operations to perform actions on the identifier.","format":"uuid","example":"dbc8231e-6b85-4955-93ce-938e25ad2f7a"},"KeyIdentifierValue":{"type":"string","description":"The contents of a key identifier."},"GooglePay3DSCryptogramKeyIdentifiers":{"title":"Google Pay 3DS_CRYPTOGRAM Key Identifiers","description":"Key identifiers for the 3DS_CRYPTOGRAM GooglePay payment instrument.","type":"object","required":["type","dpan"],"properties":{"type":{"type":"string","description":"Discriminator field."},"dpan":{"type":"object","description":"The DPAN (Device Primary Account Number) of the payment instrument.","properties":{"id":{"$ref":"#/components/schemas/KeyIdentifierId"},"value":{"$ref":"#/components/schemas/KeyIdentifierValue"}}}}},"GooglePayPanOnlyKeyIdentifiers":{"title":"Google Pay PAN_ONLY Key Identifiers","description":"Key identifiers for the PAN_ONLY GooglePay payment instrument.","type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Discriminator field."}}},"RevolutPayKeyIdentifiers":{"title":"Revolut Pay Key Identifiers","description":"Key identifiers for the Revolut Pay payment instrument.","type":"object","required":["type","fingerprint"],"properties":{"type":{"type":"string","description":"Discriminator field."},"fingerprint":{"type":"object","description":"A unique identifier for a payment method with Revolut Pay.","properties":{"id":{"$ref":"#/components/schemas/KeyIdentifierId"},"value":{"$ref":"#/components/schemas/KeyIdentifierValue"}}}}},"PayPalKeyIdentifiers":{"title":"PayPal Key Identifiers","description":"Key identifiers for the PayPal payment instrument.","type":"object","required":["type","accountId"],"properties":{"type":{"type":"string","description":"Discriminator field."},"accountId":{"type":"object","description":"A unique identifier for a payment method with PayPal.","properties":{"id":{"$ref":"#/components/schemas/KeyIdentifierId"},"value":{"$ref":"#/components/schemas/KeyIdentifierValue"}}}}},"GenericKeyIdentifiers":{"title":"Generic Key Identifiers","description":"Key Identifiers for all other payment instruments.","type":"object","required":["type","keyIdentifier"],"properties":{"type":{"type":"string","description":"Discriminator field."},"keyIdentifier":{"type":"object","description":"A unique identifier for a payment method.","properties":{"id":{"$ref":"#/components/schemas/KeyIdentifierId"},"value":{"$ref":"#/components/schemas/KeyIdentifierValue"}}}}},"PaymentInstrumentIdentifiers":{"oneOf":[{"$ref":"#/components/schemas/GooglePay3DSCryptogramKeyIdentifiers"},{"$ref":"#/components/schemas/GooglePayPanOnlyKeyIdentifiers"},{"$ref":"#/components/schemas/RevolutPayKeyIdentifiers"},{"$ref":"#/components/schemas/PayPalKeyIdentifiers"},{"$ref":"#/components/schemas/GenericKeyIdentifiers"}],"discriminator":{"propertyName":"type","mapping":{"3DS_CRYPTOGRAM":"#/components/schemas/GooglePay3DSCryptogramKeyIdentifiers","PAN_ONLY":"#/components/schemas/GooglePayPanOnlyKeyIdentifiers","REVOLUT_PAY":"#/components/schemas/RevolutPayKeyIdentifiers","PAYPAL_ACCOUNT":"#/components/schemas/PayPalKeyIdentifiers","OTHER":"#/components/schemas/GenericKeyIdentifiers"}}},"KeyIdentifiers":{"type":"object","description":"The associated key identifiers used during the transaction identifying the instrument and customer.","properties":{"customerIdentifiers":{"$ref":"#/components/schemas/CustomerIdentifiers"},"paymentInstrumentIdentifiers":{"$ref":"#/components/schemas/PaymentInstrumentIdentifiers"}}},"PaymentInstrumentAccountId":{"type":"string","description":"The unique account identifier used by the payment instrument provider (Skrill, Paypal etc.) The id is only available after the customer has logged in to their account. Only supported on a subset of payment instruments.\n","example":"customer@email.com"},"NotificationMetadata":{"type":"object","description":"Additional metadata about the notification event. Only present for merchants enrolled in Notifications V2; absent for all other merchants.\n","properties":{"source":{"type":"string","description":"The originating source of this notification event.","enum":["ORCHESTRATOR","PSP_WEBHOOK","PSP_RESPONSE"]},"entity":{"type":"string","description":"The type of entity this notification event relates to.","enum":["PAYMENT","REFUND","PAYOUT"]},"eventTimestamp":{"type":"integer","format":"int64","description":"The time the event occurred, in epoch milliseconds.","example":1734000000000}}},"PaymentStatusChangeEvent":{"allOf":[{"$ref":"#/components/schemas/TransactionCallback"},{"$ref":"#/components/schemas/RelationshipEntity"},{"$ref":"#/components/schemas/IncludedRelationships"},{"type":"object","description":"Payment callbacks may include a JSON object containing additional information regarding the payment instrument used when creating the payment. This behaviour can be enabled at the retail channel level and the information will be included for all transactions with the supported payment instruments.","required":["type","status"],"properties":{"status":{"$ref":"#/components/schemas/PaymentStatusCallback"},"cashierId":{"$ref":"#/components/schemas/CashierId"},"customerOrderCode":{"allOf":[{"$ref":"#/components/schemas/CustomerOrderCode"}],"description":"Your own order code provided upon initial order or payment.\n"},"merchantTransactionId":{"allOf":[{"$ref":"#/components/schemas/MerchantTransactionId"}],"description":"Unique identifier provided by you upon initial transaction."},"keyIdentifiers":{"$ref":"#/components/schemas/KeyIdentifiers"},"amount":{"$ref":"#/components/schemas/AmountIncludingZero"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"paymentInstrument":{"type":"string","description":"The type of payment instrument being used for the payment."},"avsResult":{"$ref":"#/components/schemas/AvsResult"},"cvvResult":{"$ref":"#/components/schemas/CvvResult"},"paymentInstrumentAccountId":{"$ref":"#/components/schemas/PaymentInstrumentAccountId"},"scaDetails":{"$ref":"#/components/schemas/ScaDetails"},"authentication":{"$ref":"#/components/schemas/Authentication"},"authorizationCode":{"$ref":"#/components/schemas/AuthorizationCode"},"notificationMetadata":{"$ref":"#/components/schemas/NotificationMetadata"},"processedAsAft":{"$ref":"#/components/schemas/ProcessedAsAft"}}}]},"TokenCallback":{"allOf":[{"$ref":"#/components/schemas/BaseCallback"},{"type":"object","required":["token"],"properties":{"token":{"type":"string","description":"The token for the associated BR-DGE Card-on-File."},"customerId":{"type":"string","description":"The ID of the customer the token is attached to."}}}]},"BasePspInfo":{"type":"object","required":["name"],"properties":{"name":{"$ref":"#/components/schemas/PspName"},"message":{"type":"string","description":"Original message provided by PSP if applicable."}}},"PspTokenInfo":{"allOf":[{"$ref":"#/components/schemas/BasePspInfo"},{"type":"object","required":["tokenId"],"properties":{"tokenId":{"type":"string","description":"The token created by the PSP for the payment instrument\n"},"pspCardFingerprint":{"type":"string","description":"The PSP fingerprint for the payment instrument\n"}}}]},"PspTokenStatus":{"type":"string","description":"The status of the psp token.\n- `ACTIVE`: Can be used to make payments with the relevant PSP.\nAdditional statuses may be added in future\n","enum":["ACTIVE"],"example":"ACTIVE"},"PspTokenStatusChangeCallback":{"allOf":[{"$ref":"#/components/schemas/TokenCallback"},{"type":"object","required":["psp"],"properties":{"psp":{"allOf":[{"$ref":"#/components/schemas/PspTokenInfo"},{"type":"object","required":["status"],"properties":{"status":{"$ref":"#/components/schemas/PspTokenStatus"},"additionalData":{"type":"object","description":"Additional fields which may be returned for a subset of PSPs when provisioning a PSP token.\n","properties":{"customerToken":{"type":"string","description":"A token which represents customer information stored with the PSP. This field is only returned\nif a `customerId` was provided when provisioning the BR-DGE Card-on-File.\n","example":"20C17E0D04D14D26E063A2598D0A4024"},"instrumentIdentifierToken":{"type":"string","description":"A token which represents a card number stored with the PSP.","example":"7010000000016241111"}}}}}]}}}]},"PspTokenProvisioningFailureCallback":{"allOf":[{"$ref":"#/components/schemas/TokenCallback"},{"type":"object","required":["psp"],"properties":{"psp":{"$ref":"#/components/schemas/BasePspInfo"}}}]},"NetworkTokenProvisioningFailedCallback":{"allOf":[{"$ref":"#/components/schemas/TokenCallback"},{"type":"object"}]},"NetworkTokenStatus":{"type":"string","description":"The status of the Network Token.\n\n- `ACTIVE`: Can be used to provision Cryptograms for payments.\n- `DISABLED`: This can be due to card suspensions, fraud, or other\n  temporary hold reasons and may be re-activated at a later date.\n\n- `DELETED`: The token is no longer valid and cannot be re-activated.\n  This can be due to token expirations, lost card or other\n  non-temporary reasons.\n","enum":["ACTIVE","DISABLED","DELETED"],"example":"ACTIVE"},"NetworkTokenIssuer":{"type":"string","enum":["Mastercard","Visa"],"description":"The issuing card network of the Network Token","example":"Mastercard"},"NetworkTokenCallback":{"type":"object","required":["status","issuer","paymentAccountReference"],"properties":{"token":{"type":"string","description":"The external identifier for the Network Token."},"status":{"$ref":"#/components/schemas/NetworkTokenStatus"},"issuer":{"$ref":"#/components/schemas/NetworkTokenIssuer"},"originalMessage":{"type":"string","description":"The original message received from the external issuer."},"paymentAccountReference":{"type":"string","description":"A non-financial reference assigned to each unique funding PAN (FPAN) that's used to link the payment account of that PAN to affiliated payment tokens. See our [dedicated PAR guide](https://docs.br-dge.io/docs/payment-account-reference)\n  for more info.\n"},"lastFour":{"type":"string","description":"Last four digits of the Network Token","example":"1234"},"cardBin":{"type":"string","description":"BIN of the associated associated Card","example":"00123456"},"cardLastFour":{"type":"string","description":"Last four digits of the associated Card","example":"1234"},"cardExpiryDate":{"type":"string","description":"Expiration date of the associated Card, noted in MM-YY Format","example":"08-26","pattern":"^(0[1-9]|1[0-2])-\\d{2}$"},"cardIssuer":{"type":"string","description":"Name of the issuing bank","example":"Bank of BR-DGE"}}},"NetworkTokenStatusChangeCallback":{"allOf":[{"$ref":"#/components/schemas/TokenCallback"},{"type":"object","required":["networkToken"],"properties":{"status":{"type":"string","deprecated":true,"description":"This field is deprecated and may be removed in the future.\nPlease use networkToken.status to determine status instead.\n"},"psp":{"$ref":"#/components/schemas/BasePspInfo"},"networkToken":{"$ref":"#/components/schemas/NetworkTokenCallback"}}}]},"NetworkTokenMetadataUpdateCallback":{"allOf":[{"$ref":"#/components/schemas/TokenCallback"},{"type":"object","required":["networkToken"],"properties":{"status":{"type":"string","deprecated":true,"description":"This field is deprecated and may be removed in the future.\nPlease use networkToken.status to determine status instead.\n"},"networkToken":{"allOf":[{"$ref":"#/components/schemas/NetworkTokenCallback"},{"type":"object","required":["isCardArtUpdated"],"properties":{"isCardArtUpdated":{"type":"boolean","description":"Whether the card art has been updated."}}}]}}}]},"PaymentInstrumentCallback":{"allOf":[{"$ref":"#/components/schemas/BaseCallback"},{"type":"object"}]},"TrustlyPaymentInstrumentAccount":{"type":"object","required":["accountId"],"allOf":[{"$ref":"#/components/schemas/TrustlyAccount"},{"type":"object","properties":{"type":{"type":"string","description":"Discriminator field. Please see the discriminator mapping for the `PaymentInstrumentAccount` schema.\n"}}}]},"PaymentInstrumentAccount":{"oneOf":[{"$ref":"#/components/schemas/TrustlyPaymentInstrumentAccount"}],"discriminator":{"propertyName":"type","mapping":{"trustly":"#/components/schemas/TrustlyPaymentInstrumentAccount"}}},"PaymentInstrumentAccountSelectionCallback":{"allOf":[{"$ref":"#/components/schemas/PaymentInstrumentCallback"},{"type":"object","required":["id","account"],"properties":{"psp":{"allOf":[{"$ref":"#/components/schemas/BasePspInfo"},{"type":"object","properties":{"transactionId":{"type":"string","description":"Identifier provided by the PSP this notification was received from.\n"}}}]},"customerId":{"type":"string","description":"The merchant's ID of the customer the account is attached to.","example":"2c6a34be-f7a1-4b49-b09c-e84e1322df7f"},"id":{"type":"string","description":"The unique identifier of the source transaction.","example":"81f7baee-2955-4fee-8d6f-289f8579b360"},"source":{"type":"string","enum":["PAYMENT","VERIFICATION","REGISTRATION"],"description":"The source of interaction that this notification came from.","example":"PAYMENT"},"account":{"$ref":"#/components/schemas/PaymentInstrumentAccount"},"paymentInstrumentAccountId":{"$ref":"#/components/schemas/PaymentInstrumentAccountId"},"amount":{"$ref":"#/components/schemas/AmountIncludingZero"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"}}}]},"RefundStatus":{"type":"string","description":"Status of the refund. See [Transaction Statuses](https://docs.br-dge.io/docs/transaction-statuses)  for further detail.\n","example":"APPROVED","enum":["APPROVED","PENDING","DECLINED","UNKNOWN"]},"RefundStatusChangeEvent":{"allOf":[{"$ref":"#/components/schemas/TransactionCallback"},{"type":"object","required":["status"],"properties":{"status":{"$ref":"#/components/schemas/RefundStatus"},"notificationMetadata":{"$ref":"#/components/schemas/NotificationMetadata"}}}]},"Amount":{"title":"amount","type":"integer","format":"int64","minimum":1,"maximum":999999999999999,"example":1234,"description":"Amount in a currency to be used for the transaction.\nIn the lowest denomination of the currency of the payment.\nThis means that `1234` in GBP represents `£12.34`.\n"},"PayoutStatus":{"type":"string","description":"Status of the payout. See [Transaction Statuses](https://docs.br-dge.io/docs/transaction-statuses)  for further detail.\n","example":"APPROVED","enum":["PENDING","APPROVED","DECLINED","REJECTED","HELD","CANCELLED","BLOCKED","UNKNOWN"]},"AccountNumberZa":{"type":"string","description":"Recipient's bank account number.","example":"1352184990","minLength":7,"pattern":"^[0-9]*$"},"PayoutStatusChangeEvent":{"allOf":[{"$ref":"#/components/schemas/TransactionCallback"},{"type":"object","required":["status","payout"],"properties":{"payout":{"type":"object","description":"Information about the payout","required":["type"],"properties":{"type":{"type":"string","description":"Whether the payout was of type standard, fast funds, or unknown.","default":"UNKNOWN","enum":["STANDARD","FAST_FUNDS","UNKNOWN"]}}},"status":{"$ref":"#/components/schemas/PayoutStatus"},"cashierId":{"$ref":"#/components/schemas/CashierId"},"reference":{"allOf":[{"$ref":"#/components/schemas/CustomerOrderCode"}],"description":"A reference you provided to identify this payout.\n"},"merchantTransactionId":{"allOf":[{"$ref":"#/components/schemas/MerchantTransactionId"}],"description":"Unique identifier provided by you upon initial transaction."},"keyIdentifiers":{"$ref":"#/components/schemas/KeyIdentifiers"},"amount":{"$ref":"#/components/schemas/AmountIncludingZero"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"paymentInstrument":{"$ref":"#/components/schemas/PaymentInstrument"},"paymentInstrumentAccountId":{"$ref":"#/components/schemas/PaymentInstrumentAccountId"},"notificationMetadata":{"$ref":"#/components/schemas/NotificationMetadata"}}}]}},"parameters":{"pathOrderId":{"name":"orderId","in":"path","description":"The unique identifier for the Order.\n\nThis can be sourced from the `orderId` field in the response we sent to you when creating the Order.\n","required":true,"schema":{"type":"string"}},"pathPaymentId":{"name":"paymentId","in":"path","description":"The unique identifier for the payment.\n\nThis can be sourced from the `paymentId` field in the response we sent to you when creating the payment or payout.\n","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"}}},"securitySchemes":{"ServerApiKey":{"type":"http","scheme":"bearer","description":"Operations intended for use by Merchant servers.\n\n**IMPORTANT** This key allows you to perform sensitive operations such as authorizing payments and refunds.\n\n**Production Server API keys must not be accessible outside your organization.**\n"}},"examples":{"payment-request-tokenized":{"summary":"Payment with Tokenized Payment Instrument.","description":"Tokenized payment instruments can be used in place of sensitive cardholder data.","value":{"amount":1000,"paymentInstrument":{"type":"tokenized","token":"5caa5a2a-be0b-4160-ae21-1bbbf2267f4c"},"channel":"web","origin":"https://example.com/checkout","billingAddress":{"firstName":"John","lastName":"Smith","buildingNumberOrName":"Flat 1","address1":"Victoria House","address2":"15 Apple Street","town":"Edinburgh","county":"Lothian","postcode":"BH23 6AA","country":"GB","phoneNumber":"+44 123 1110000"},"browserData":{"acceptHeader":"application/json","colorDepth":"32","javaEnabled":true,"language":"EN_en","screenHeight":768,"screenWidth":1024,"timeZone":0,"userAgent":"Mozilla/5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/67.0.3396.99 Safari/537.36"},"currencyCode":"GBP","customerEmail":"a@b.com","customerFirstName":"John","customerIpAddress":"123.100.100.200","customerLastName":"Smith","customerOrderCode":"ABC123","customerPhoneNumber":"+44 123 1110000","customerSessionId":"123456","deliveryAddress":{"firstName":"John","lastName":"Smith","buildingNumberOrName":"Flat 1","address1":"Victoria House","address2":"15 Apple Street","town":"Edinburgh","county":"Lothian","postcode":"BH23 6AA","country":"GB","phoneNumber":"+44 123 1110000"},"orderDescription":"Taxi fare","threeDSecureOptions":{"challengeRequested":false,"exemptionRequested":false},"threeDSecureRequired":true}},"payment-request-card":{"summary":"Payment with Card Payment Instrument","value":{"amount":1000,"paymentInstrument":{"type":"card","nameOnCard":"John F Doe","pan":"4444 3333 2222 1111","expiryDate":"01-99","startDate":"01-00","issueNumber":1,"cv2":"000","storedCredentialIndicator":"FIRST"},"channel":"ios","billingAddress":{"firstName":"John","lastName":"Smith","buildingNumberOrName":"Flat 1","address1":"Victoria House","address2":"15 Apple Street","town":"Edinburgh","county":"Lothian","postcode":"BH23 6AA","country":"GB","phoneNumber":"+44 123 1110000"},"browserData":{"acceptHeader":"application/json","colorDepth":"32","javaEnabled":true,"language":"EN_en","screenHeight":768,"screenWidth":1024,"timeZone":0,"userAgent":"Mozilla/5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/67.0.3396.99 Safari/537.36"},"currencyCode":"GBP","customerEmail":"a@b.com","customerFirstName":"John","customerIpAddress":"123.100.100.200","customerLastName":"Smith","customerOrderCode":"ABC123","customerPhoneNumber":"+44 123 1110000","customerSessionId":"123456","deliveryAddress":{"firstName":"John","lastName":"Smith","buildingNumberOrName":"Flat 1","address1":"Victoria House","address2":"15 Apple Street","town":"Edinburgh","county":"Lothian","postcode":"BH23 6AA","country":"GB","phoneNumber":"+44 123 1110000"},"orderDescription":"Taxi fare","threeDSecureOptions":{"challengeRequested":false,"exemptionRequested":false},"threeDSecureRequired":true}},"payment-request-card-aft":{"summary":"AFT Payment with Card Payment Instrument","value":{"amount":1000,"paymentInstrument":{"type":"card","nameOnCard":"John F Doe","pan":"4444 3333 2222 1111","expiryDate":"01-99","startDate":"01-00","issueNumber":1,"cv2":"000"},"channel":"ios","billingAddress":{"firstName":"John","lastName":"Smith","buildingNumberOrName":"Flat 1","address1":"Victoria House","address2":"15 Apple Street","town":"Edinburgh","county":"Lothian","postcode":"BH23 6AA","country":"GB","phoneNumber":"+44 123 1110000"},"browserData":{"acceptHeader":"application/json","colorDepth":"32","javaEnabled":true,"language":"EN_en","screenHeight":768,"screenWidth":1024,"timeZone":0,"userAgent":"Mozilla/5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/67.0.3396.99 Safari/537.36"},"currencyCode":"GBP","customerEmail":"a@b.com","customerFirstName":"John","customerIpAddress":"123.100.100.200","customerLastName":"Smith","customerDateOfBirth":"2000-01-01","customerOrderCode":"ABC123","customerPhoneNumber":"+44 123 1110000","customerSessionId":"123456","deliveryAddress":{"firstName":"John","lastName":"Smith","buildingNumberOrName":"Flat 1","address1":"Victoria House","address2":"15 Apple Street","town":"Edinburgh","county":"Lothian","postcode":"BH23 6AA","country":"GB","phoneNumber":"+44 123 1110000"},"orderDescription":"Taxi fare","aft":{"fundingPurpose":"DONATIONS","fundingType":"PERSON_TO_PERSON"},"recipient":{"title":"Mr","firstName":"John","lastName":"Smith","ipAddress":"123.100.100.200","customerId":"abc123","documentIssuer":"GB","documentId":"def456","documentType":"DNI","email":"a@b.com","gender":"male","dateOfBirth":"2000-01-01","address":{"buildingNumberOrName":"10","address1":"Victoria House","address2":"15 Apple Street","town":"Edinburgh","county":"City of Edinburgh","postcode":"EH3 1N9","country":"GB","countrySubdivisionCode":"WY"},"phoneNumber":"01234 567890","middleName":"James","accountNumber":"12345789","accountType":"BANK_ACCOUNT"}}},"payment-request-card-create-card-on-file":{"summary":"Payment with Card Payment Instrument and create Card on File","description":"Please note that although 3-D secure is not requested in this\nexample, some PSPs will automatically apply 3-D Secure to the\nfirst payment made with new Card on File.\n","value":{"amount":1000,"paymentInstrument":{"type":"card","nameOnCard":"John F Doe","pan":"4444 3333 2222 1111","expiryDate":"01-99","startDate":"01-00","issueNumber":1,"cv2":"000","tokenize":true,"storedCredentialIndicator":"SUBSEQUENT"},"channel":"ios","billingAddress":{"firstName":"John","lastName":"Smith","buildingNumberOrName":"Flat 1","address1":"Victoria House","address2":"15 Apple Street","town":"Edinburgh","county":"Lothian","postcode":"BH23 6AA","country":"GB","phoneNumber":"+44 123 1110000"},"browserData":{"acceptHeader":"application/json","colorDepth":"32","javaEnabled":true,"language":"EN_en","screenHeight":768,"screenWidth":1024,"timeZone":0,"userAgent":"Mozilla/5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/67.0.3396.99 Safari/537.36"},"currencyCode":"GBP","customerEmail":"a@b.com","customerFirstName":"John","customerIpAddress":"123.100.100.200","customerLastName":"Smith","customerOrderCode":"ABC123","customerPhoneNumber":"+44 123 1110000","customerSessionId":"123456","deliveryAddress":{"firstName":"John","lastName":"Smith","buildingNumberOrName":"Flat 1","address1":"Victoria House","address2":"15 Apple Street","town":"Edinburgh","county":"Lothian","postcode":"BH23 6AA","country":"GB","phoneNumber":"+44 123 1110000"},"orderDescription":"Taxi fare","threeDSecureRequired":true}},"payment-request-paypal":{"summary":"Payment with PayPal Payment Instrument","value":{"amount":1000,"paymentInstrument":{"type":"payPal","nonce":"XX#5caa5a2a-be0b-4160-ae21-1bbbf2267f4c"},"channel":"android","billingAddress":{"firstName":"John","lastName":"Smith","buildingNumberOrName":"Flat 1","address1":"Victoria House","address2":"15 Apple Street","town":"Edinburgh","county":"Lothian","postcode":"BH23 6AA","country":"GB","phoneNumber":"+44 123 1110000"},"browserData":{"acceptHeader":"application/json","colorDepth":"32","javaEnabled":true,"language":"EN_en","screenHeight":768,"screenWidth":1024,"timeZone":0,"userAgent":"Mozilla/5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/67.0.3396.99 Safari/537.36"},"currencyCode":"GBP","customerEmail":"a@b.com","customerFirstName":"John","customerIpAddress":"123.100.100.200","customerLastName":"Smith","customerOrderCode":"ABC123","customerPhoneNumber":"+44 123 1110000","customerSessionId":"123456","deliveryAddress":{"firstName":"John","lastName":"Smith","buildingNumberOrName":"Flat 1","address1":"Victoria House","address2":"15 Apple Street","town":"Edinburgh","county":"Lothian","postcode":"BH23 6AA","country":"GB","phoneNumber":"+44 123 1110000"},"orderDescription":"Taxi fare","threeDSecureOptions":{"challengeRequested":false,"exemptionRequested":false},"threeDSecureRequired":true}},"payment-request-googlepay":{"summary":"Payment with Google Pay Payment Instrument","description":"A type of [Payment Instrument](https://docs.br-dge.io/docs/introduction#payment-instrument).\n## If you integrate directly with the Google Pay&trade; API\nFollow the procedure in the Google Pay documentation to integrate your [web](https://developers.google.com/pay/api/web/guides/setup) or [Android](https://developers.google.com/pay/api/android/guides/setup) application.\nIn the step where you choose a payment tokenization method, choose `Gateway`, then set `comcarde` as your `gateway`. If you have not been provided with a `gatewayMerchantId` parameter, please raise a ticket with support on the BR-DGE Support Portal at <https://docs.br-dge.io/docs/support#contact-support>.\n## If you use a BR-DGE SDK\nThe BR-DGE SDK can optionally be used to automate client side interactions with the Google Pay&trade; API. The SDK will output a nonce that you can directly use.\nFor more information please refer to the [Google Pay Feature](https://docs.br-dge.io/docs/features-google-pay page.\n","value":{"amount":1000,"paymentInstrument":{"type":"googlePay","nonce":"{\"apiVersion\":2,\"apiVersionMinor\":0, \"paymentMethodData\":{\"description\": \"Test Card: Visa •••• 1111\", \"info\":{\"assuranceDetails\":{\"accountVerified\":true, \"cardHolderAuthenticated\":false},\"cardDetails\":\"1111\", \"cardNetwork\":\"VISA\"},\"tokenizationData\":{\"token\": \"{\"signature\":\"MEUCIBSc1HRfQds/JkpNXakkaJf2geKR9HZE4Rhof/ qnNRymAiEArDzEmaOC+lTqzHmvA+Z1sFfRMROdtr0pTAGVFWUjLV4u003d\", \"intermediateSigningKey\":{\"signedKey\":\"{\"keyValue\": \"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE60Dnzr+/JD +xJOOIFBMRyVoqPCbQcBjj/TwGJu9ct/srT8tZDDWJzNZo2vDE50YLE38oHBJWLjAws hqDzKfQKQu003du003d\",\"keyExpiration \":\"1710831722061\"}\",\"signatures\":[\"M EUCIQDqib3bqGDAzyQRRtc7xci1EzhNqxAj1oEIrCfSiUd7WAIgc09CIVz7zKa9StsZ Bw95vvoRORsbF1qCKtPk5ltQihEu003d\"]},\"protocolVersion\": \"ECv2\",\"signedMessage\":\"{\"encryptedMessage \":\"My/Y7NLgWNCMiQzd/muw8XyCMDhMS38j9FjTyKPsmKNWM5UHl+PkT urYyVv6kSJGAkWF6HCBIx3J1Ch6kJtx4w8/pmP7ujxCwEiDiynsffAIeubQpkv69gIp +H/SZs7DiqOvdhXhHF5vpkYvU3NmVMjvNZeU3rgclwldC1IAJzGyxdafLYu7WKtajEv bBfIq/Rp+XXGkTw4pkGt7MYVNcWqUY4qO1mRmIyyj+UrR5wru9rXlxZu9xA0ofdBc4a 8tkOp6wUgD+5+VMZ3GbUrQZbV+hnwFqMl60U1+u2nSr9PInbusVT73tqr2Y37EmViCC I1s0Evoj8nakWgblLQ9L0HMS2G9XdIvktuLS2oDDxZziv1IquBShyYeik0Hhceq5HK9 d16MTIpLm1kP188YL1TtHoVCRNJX0T5lTfsTATN9PsMp9fl+SRBzjr2ZrfFtyjJB652 wi6FMJquIcVIoc1t6HAJ6ZQQyaR8gWaV+/BmkIm6EPmOUczF5sYTNGXilnKf91PwaoN zhBnatlx468fqkvyKGN5pjfsK2BCUGJJw9UwiYPWNrD24fzJ/Fwlxh0uToo5CiT8KmA qoKSxzJ9Fh/XtVsbbH0+yfUBNUfLsWs3Rsu003d\",\"eph emeralPublicKey\":\"BLyIO17wMMcKccD9XJMlUQ8vHnI3IfoE6Ss bQuVxerTtolZ7ICGRhW0lbxF3q7blzvgSDIYLk9cab27mCKT0sy0u003d \",\"tag\":\"CIKT0sRruAuW7nJ3THAgZuWHpE0PJBc4 eLmfHRWZgpsu003d\"}\"}\", \"type\":\"PAYMENT_GATEWAY\"},\"type\":\"CARD\"}}"},"channel":"web","origin":"https://example.com/checkout","billingAddress":{"firstName":"John","lastName":"Smith","buildingNumberOrName":"Flat 1","address1":"Victoria House","address2":"15 Apple Street","town":"Edinburgh","county":"Lothian","postcode":"BH23 6AA","country":"GB","phoneNumber":"+44 123 1110000"},"browserData":{"acceptHeader":"application/json","colorDepth":"32","javaEnabled":true,"language":"EN_en","screenHeight":768,"screenWidth":1024,"timeZone":0,"userAgent":"Mozilla/5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/67.0.3396.99 Safari/537.36"},"currencyCode":"GBP","customerEmail":"a@b.com","customerFirstName":"John","customerIpAddress":"123.100.100.200","customerLastName":"Smith","customerOrderCode":"ABC123","customerPhoneNumber":"+44 123 1110000","customerSessionId":"123456","deliveryAddress":{"firstName":"John","lastName":"Smith","buildingNumberOrName":"Flat 1","address1":"Victoria House","address2":"15 Apple Street","town":"Edinburgh","county":"Lothian","postcode":"BH23 6AA","country":"GB","phoneNumber":"+44 123 1110000"},"orderDescription":"Taxi fare","threeDSecureOptions":{"challengeRequested":false,"exemptionRequested":false},"threeDSecureRequired":true}},"payment-request-applepay":{"summary":"Payment with Apple Pay Payment Instrument.","description":"Apple Pay is a digital Wallet that offers your customers a simple, secure, and private way to pay within your iOS and watchOS apps, and on your websites via Safari. For more information please refer to the BR-DGE [Apple Pay feature guide].\n\nIf you are directly integrating with Apple Pay APIs on your client app then please refer to our [Apple Pay REST API guide] for details on how to generate an Apple Pay token for BR-DGE Payments.\n\nAlternatively you can use the [BR-DGE Web SDK Apple Pay module] to directly generate Apple Pay tokens for BR-DGE Payments.\n\n[Payment Instrument]: https://docs.br-dge.io/docs/introduction#payment-instrument\n[Apple Pay feature guide]: https://docs.br-dge.io/docs/features-apple-pay\n[Apple Pay REST API guide]: https://docs.br-dge.io/docs/rest-api-apple-pay\n[BR-DGE Web SDK Apple Pay module]: https://docs.br-dge.io/docs/apple-pay-module\n","value":{"amount":1000,"paymentInstrument":{"type":"applePay","nonce":"{\\\"token\\\":{\\\"paymentData\\\":{\\\"data\\\":\\\"0yioGeu8hRsiWLcGmwidZqaSsE==\\\" ,\\\"signature\\\":\\\"MIAGCSqGSIb3DQEHABp0wQAAAAAAAA==\\\",\\\"header\\\":{\\\"publicKeyHash\\\" :\\\"QVELqOnrjSM72c=\\\",\\\"ephemeralPublicKey\\\":\\\"MFkwEw==\\\", \\\"transactionId\\\":\\\"c97c470d8\\\"},\\\"version\\\":\\\"EC_v1\\\"},\\\"paymentMethod\\\": {\\\"displayName\\\":\\\"Visa 0326\\\",\\\"network\\\":\\\"Visa\\\",\\\"type\\\":\\\"debit\\\"}, \\\"transactionIdentifier\\\":\\\"905db24434224570d8\\\"}}"},"channel":"ios","billingAddress":{"firstName":"John","lastName":"Smith","buildingNumberOrName":"Flat 1","address1":"Victoria House","address2":"15 Apple Street","town":"Edinburgh","county":"Lothian","postcode":"BH23 6AA","country":"GB","phoneNumber":"+44 123 1110000"},"browserData":{"acceptHeader":"application/json","colorDepth":"32","javaEnabled":true,"language":"EN_en","screenHeight":768,"screenWidth":1024,"timeZone":0,"userAgent":"Mozilla/5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/67.0.3396.99 Safari/537.36"},"currencyCode":"GBP","customerEmail":"a@b.com","customerFirstName":"John","customerIpAddress":"123.100.100.200","customerLastName":"Smith","customerOrderCode":"ABC123","customerPhoneNumber":"+44 123 1110000","customerSessionId":"123456","deliveryAddress":{"firstName":"John","lastName":"Smith","buildingNumberOrName":"Flat 1","address1":"Victoria House","address2":"15 Apple Street","town":"Edinburgh","county":"Lothian","postcode":"BH23 6AA","country":"GB","phoneNumber":"+44 123 1110000"},"orderDescription":"Taxi fare","threeDSecureOptions":{"challengeRequested":false,"exemptionRequested":false},"threeDSecureRequired":true}},"payment-request-providerThreeDSecureNonce":{"summary":"Payment with ProviderThreeDSecureNonce Payment Instrument.","description":"Part of the [3-D Secure Payment Flow]. In the event that you get a 3D Secure additional action required response to a payment request, you can use our [Web SDK Post Response Module] to handle the action and convert it into a nonce you can use to complete the payment with a ProviderThreeDSecureNonce Payment Instrument.\n\n[3-D Secure Payment Flow]: https://docs.br-dge.io/docs/introduction#3-d-secure\n[Web SDK Post Response Module]: https://docs.br-dge.io/docs/post-response-module\n","value":{"amount":1000,"paymentInstrument":{"type":"providerThreeDSecureNonce","paymentId":"45951071-980e-45db-b3d4-5377655de82e","nonce":"XX#5caa5a2a-be0b-4160-ae21-1bbbf2267f4c"},"channel":"web","origin":"https://example.com/checkout","billingAddress":{"firstName":"John","lastName":"Smith","buildingNumberOrName":"Flat 1","address1":"Victoria House","address2":"15 Apple Street","town":"Edinburgh","county":"Lothian","postcode":"BH23 6AA","country":"GB","phoneNumber":"+44 123 1110000"},"browserData":{"acceptHeader":"application/json","colorDepth":"32","javaEnabled":true,"language":"EN_en","screenHeight":768,"screenWidth":1024,"timeZone":0,"userAgent":"Mozilla/5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/67.0.3396.99 Safari/537.36"},"currencyCode":"GBP","customerEmail":"a@b.com","customerFirstName":"John","customerIpAddress":"123.100.100.200","customerLastName":"Smith","customerOrderCode":"ABC123","customerPhoneNumber":"+44 123 1110000","customerSessionId":"123456","deliveryAddress":{"firstName":"John","lastName":"Smith","buildingNumberOrName":"Flat 1","address1":"Victoria House","address2":"15 Apple Street","town":"Edinburgh","county":"Lothian","postcode":"BH23 6AA","country":"GB","phoneNumber":"+44 123 1110000"},"orderDescription":"Taxi fare","threeDSecureOptions":{"challengeRequested":false,"exemptionRequested":false},"threeDSecureRequired":true}},"payment-request-split-auth-and-capture":{"summary":"Split Auth and Capture","description":"By default payments are captured immediately, but by setting `intent` to `authorize` you can control when the payment is captured or voided using the `/payments/{paymentId}/capture` and `/payments/{paymentId}/void` endpoints.\n","value":{"intent":"authorize","amount":1000,"paymentInstrument":{"type":"tokenized","token":"5caa5a2a-be0b-4160-ae21-1bbbf2267f4c"},"channel":"web","origin":"https://example.com/checkout","billingAddress":{"firstName":"John","lastName":"Smith","buildingNumberOrName":"Flat 1","address1":"Victoria House","address2":"15 Apple Street","town":"Edinburgh","county":"Lothian","postcode":"BH23 6AA","country":"GB","phoneNumber":"+44 123 1110000"},"browserData":{"acceptHeader":"application/json","colorDepth":"32","javaEnabled":true,"language":"EN_en","screenHeight":768,"screenWidth":1024,"timeZone":0,"userAgent":"Mozilla/5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/67.0.3396.99 Safari/537.36"},"currencyCode":"GBP","customerEmail":"a@b.com","customerFirstName":"John","customerIpAddress":"123.100.100.200","customerLastName":"Smith","customerOrderCode":"ABC123","customerPhoneNumber":"+44 123 1110000","customerSessionId":"123456","deliveryAddress":{"firstName":"John","lastName":"Smith","buildingNumberOrName":"Flat 1","address1":"Victoria House","address2":"15 Apple Street","town":"Edinburgh","county":"Lothian","postcode":"BH23 6AA","country":"GB","phoneNumber":"+44 123 1110000"},"orderDescription":"Taxi fare","threeDSecureOptions":{"challengeRequested":false,"exemptionRequested":false},"threeDSecureRequired":true}},"payment-request-ideal":{"summary":"Payment with iDEAL Payment Instrument.","description":"Note that the success and error URLs should not be easily guessable.\n\nBy using unpredictable single-use URLs you can protect yourself from the possibility of bad actors attempting to make it appear that payments had a different outcome to reality. We also recommend that you confirm the outcome of payments via server-to-server calls to BR-DGE.\n","value":{"amount":1000,"paymentInstrument":{"type":"ideal","successUrl":"https://myurl.com/success/f219ea52-d91f-4059-a560-8dd7cbd31fd0","errorUrl":"https://myurl.com/error/a73fba88-7874-4d2f-b946-27cfade80be0"},"channel":"ios","billingAddress":{"firstName":"John","lastName":"Smith","buildingNumberOrName":"Flat 1","address1":"Edisonbaan","address2":"15 Apple Street","town":"Amsterdan","county":"Nieuwegein","postcode":"3439 MN","country":"NL"},"currencyCode":"EUR","customerEmail":"a@b.com","customerFirstName":"John","customerIpAddress":"123.100.100.200","customerLastName":"Smith","customerOrderCode":"ABC123","customerPhoneNumber":"+44 123 1110000","customerSessionId":"123456","deliveryAddress":{"firstName":"John","lastName":"Smith","buildingNumberOrName":"Flat 1","address1":"Victoria House","address2":"15 Apple Street","town":"Edinburgh","county":"Lothian","postcode":"BH23 6AA","country":"GB","phoneNumber":"+44 123 1110000"},"orderDescription":"Taxi fare"}},"payment-request-bancontact":{"summary":"Payment with Bancontact Payment Instrument.","description":"Note that the success and error URLs should not be easily guessable.\n\nBy using unpredictable single-use URLs you can protect yourself from the possibility of bad actors attempting to make it appear that payments had a different outcome to reality. We also recommend that you confirm the outcome of payments via server-to-server calls to BR-DGE.\n","value":{"amount":1000,"paymentInstrument":{"type":"bancontact","successUrl":"https://myurl.com/success/f219ea52-d91f-4059-a560-8dd7cbd31fd0","errorUrl":"https://myurl.com/error/a73fba88-7874-4d2f-b946-27cfade80be0"},"channel":"ios","billingAddress":{"firstName":"John","lastName":"Smith","buildingNumberOrName":"Flat 1","address1":"Chaussee de Wavre 1520","town":"Auderghem","county":"Brussels","postcode":"1160","country":"BE"},"currencyCode":"EUR","customerEmail":"a@b.com","customerFirstName":"John","customerIpAddress":"123.100.100.200","customerLastName":"Smith","customerOrderCode":"ABC123","customerPhoneNumber":"+44 123 1110000","customerSessionId":"123456","deliveryAddress":{"firstName":"John","lastName":"Smith","buildingNumberOrName":"Flat 1","address1":"Victoria House","address2":"15 Apple Street","town":"Edinburgh","county":"Lothian","postcode":"BH23 6AA","country":"GB","phoneNumber":"+44 123 1110000"},"orderDescription":"Taxi fare"}},"payment-request-trustly":{"summary":"Payment with Trustly Payment Instrument.","description":"Note that the success and error URLs should not be easily guessable.\n\nBy using unpredictable single-use URLs you can protect yourself from the possibility of bad actors attempting to make it appear that payments had a different outcome to reality. We also recommend that you confirm the outcome of payments via server-to-server calls to BR-DGE.\n","value":{"amount":1000,"paymentInstrument":{"type":"trustly","successUrl":"https://myurl.com/success/f219ea52-d91f-4059-a560-8dd7cbd31fd0","errorUrl":"https://myurl.com/error/a73fba88-7874-4d2f-b946-27cfade80be0","accountId":"1234567890"},"channel":"ios","billingAddress":{"firstName":"John","lastName":"Smith","buildingNumberOrName":"Flat 1","address1":"Chaussee de Wavre 1520","town":"Auderghem","county":"Brussels","postcode":"1160","country":"BE"},"browserData":{"language":"EN_en"},"currencyCode":"EUR","customerEmail":"a@b.com","customerFirstName":"John","customerId":"ABC1234","customerIpAddress":"123.100.100.200","customerLastName":"Smith","customerOrderCode":"ABC123","customerPhoneNumber":"+44 123 1110000","customerSessionId":"123456","deliveryAddress":{"firstName":"John","lastName":"Smith","buildingNumberOrName":"Flat 1","address1":"Victoria House","address2":"15 Apple Street","town":"Edinburgh","county":"Lothian","postcode":"BH23 6AA","country":"GB","phoneNumber":"+44 123 1110000"},"orderDescription":"Taxi fare"}},"payment-request-paysafecard":{"summary":"Payment with Paysafecard Payment Instrument.","description":"Note that the success and error URLs should not be easily guessable.\n\nBy using unpredictable single-use URLs you can protect yourself from the possibility of bad actors attempting to make it appear that payments had a different outcome to reality. We also recommend that you confirm the outcome of payments via server-to-server calls to BR-DGE.\n","value":{"amount":1000,"paymentInstrument":{"type":"paysafecard","successUrl":"https://myurl.com/success/f219ea52-d91f-4059-a560-8dd7cbd31fd0","errorUrl":"https://myurl.com/error/a73fba88-7874-4d2f-b946-27cfade80be0","countryRestriction":"BE","kycLevel":"SIMPLE","minAge":18,"submerchantId":"1"},"currencyCode":"EUR","customerId":"8eee4037-c953-4010-98ca-f9c02b775a89","customerOrderCode":"ABC123","customerSessionId":"123456","orderDescription":"Taxi fare"}},"payment-request-pix":{"summary":"Payment with Pix Payment Instrument.","description":"Note that the success and error URLs should not be easily guessable.\n\nBy using unpredictable single-use URLs you can protect yourself from the possibility of bad actors attempting to make it appear that payments had a different outcome to reality. We also recommend that you confirm the outcome of payments via server-to-server calls to BR-DGE.\n","value":{"amount":1000,"paymentInstrument":{"type":"pix","successUrl":"https://myurl.com/success/f219ea52-d91f-4059-a560-8dd7cbd31fd0","errorUrl":"https://myurl.com/error/a73fba88-7874-4d2f-b946-27cfade80be0"},"billingAddress":{"address1":"Av. Paulista, 1098, 1º andar, apto. 101","town":"Rio de Janeiro","county":"RJ","postcode":"13010-111","country":"BR"},"currencyCode":"USD","customerEmail":"a@b.com","customerFirstName":"John","customerIpAddress":"123.100.100.200","customerLastName":"Smith","customerOrderCode":"ABC123","customerPhoneNumber":"+44 123 1110000","documentId":"84932568207","orderDescription":"Taxi fare"}},"payment-request-astropay":{"summary":"Payment with AstroPay Payment Instrument.","description":"Note that the redirect URL should not be easily guessable. By using unpredictable single-use URLs you can protect yourself from the possibility of bad actors attempting to make it appear that payments had a different outcome to reality. We also recommend that you confirm the outcome of payments via server-to-server calls to BR-DGE.\n","value":{"amount":1000,"paymentInstrument":{"type":"astroPay","redirectUrl":"https://myurl.com/f219ea52-d91f-4059-a560-8dd7cbd31fd0","productCode":"1234567890","productDescription":"Product Description"},"channel":"ios","billingAddress":{"firstName":"John","lastName":"Smith","buildingNumberOrName":"Flat 1","address1":"Edisonbaan","address2":"15 Apple Street","town":"Amsterdan","county":"Nieuwegein","postcode":"3439 MN","country":"NL"},"currencyCode":"EUR","customerEmail":"a@b.com","customerFirstName":"John","customerIpAddress":"123.100.100.200","customerLastName":"Smith","customerOrderCode":"ABC123","customerId":"Customer Id","customerPhoneNumber":"+44 123 1110000","customerSessionId":"123456","deliveryAddress":{"firstName":"John","lastName":"Smith","buildingNumberOrName":"Flat 1","address1":"Victoria House","address2":"15 Apple Street","town":"Edinburgh","county":"Lothian","postcode":"BH23 6AA","country":"GB","phoneNumber":"+44 123 1110000"},"orderDescription":"Taxi fare"}},"payment-request-neteller":{"summary":"Payment with Neteller Payment Instrument.","description":"Note that the redirect URLs should not be easily guessable. By using unpredictable single-use URLs you can protect yourself from the possibility of bad actors attempting to make it appear that payments had a different outcome to reality. We also recommend that you confirm the outcome of payments via server-to-server calls to BR-DGE. The `customerEmail` field must be the e-mail address of the Neteller customer.\n","value":{"amount":1000,"paymentInstrument":{"type":"neteller","defaultUrl":"https://myurl.com/success/733a54a3-86d0-486c-b02a-6c3441b9a186","failedUrl":"https://myurl.com/fail/e25f065c-7727-4243-a2c8-a11e39718a95","cancelledUrl":"https://myurl.com/cancel/9f9f39a4-6b3e-440d-885c-739e41db2c9a"},"channel":"ios","billingAddress":{"firstName":"John","lastName":"Smith","buildingNumberOrName":"Flat 1","address1":"Edisonbaan","address2":"15 Apple Street","town":"Amsterdan","county":"Nieuwegein","postcode":"3439 MN","country":"NL"},"currencyCode":"EUR","customerEmail":"a@b.com","customerFirstName":"John","customerIpAddress":"123.100.100.200","customerLastName":"Smith","customerOrderCode":"ABC123","customerId":"Customer Id","customerPhoneNumber":"+44 123 1110000","customerSessionId":"123456","deliveryAddress":{"firstName":"John","lastName":"Smith","buildingNumberOrName":"Flat 1","address1":"Victoria House","address2":"15 Apple Street","town":"Edinburgh","county":"Lothian","postcode":"BH23 6AA","country":"GB","phoneNumber":"+44 123 1110000"},"orderDescription":"Taxi fare"}},"payment-request-oneVoucher":{"summary":"Payment with 1Voucher Payment Instrument.","description":"The amount should be set to 0 to indicate that the entire value of the voucher will be captured by the PSP, and will be unknown until a response is returned. ZAR is the only supported currency code.\n","value":{"amount":0,"paymentInstrument":{"type":"oneVoucher","pin":"1111222233334444"},"currencyCode":"ZAR","customerOrderCode":"ABC456","orderDescription":"Taxi fare"}},"payment-request-ottVoucher":{"summary":"Payment with OTT Voucher Payment Instrument.","description":"The amount should be set to 0 to indicate that the entire value of the voucher will be captured by the PSP. ZAR is the only supported currency code.\n","value":{"amount":20,"paymentInstrument":{"type":"ottVoucher","pin":"455844447422","mobile":"447712345678"},"currencyCode":"ZAR","customerId":"44773429-8b07-4973-b9de-3d308e86b955","customerOrderCode":"ABC456","orderDescription":"Taxi fare"}},"payment-request-bluVoucher":{"summary":"Payment with BluVoucher Payment Instrument.","description":"The amount should be either set to 0 to indicate that the entire value of the voucher will be captured by the PSP, or set to full amount only. ZAR is the only supported currency code.\n","value":{"amount":20,"paymentInstrument":{"type":"bluVoucher","pin":"455844447422"},"currencyCode":"ZAR","customerId":"44773429-8b07-4973-b9de-3d308e86b955","customerOrderCode":"ABC456","customerPhoneNumber":"+44 1231110000","customerEmail":"a@b.com","orderDescription":"Taxi fare"}},"payment-request-revolutpay":{"summary":"Payment with Revolut Pay Payment Instrument.","description":"Note that the redirect URLs should not be easily guessable. By using unpredictable single-use URLs you can protect yourself from the possibility of bad actors attempting to make it appear that payments had a different outcome to reality. We also recommend that you confirm the outcome of payments via server-to-server calls to BR-DGE. The `customerId` field maps directly to the Revolut customer ID, if no `customerId` is provided a new one will be generated based on `customerEmail`, `customerFirstName` and `customerLastName`.\n","value":{"amount":1000,"paymentInstrument":{"type":"revolutPay","appReturnUrl":"https://myurl.com/return/733a54a3-86d0-486c-b02a-6c3441b9a186","revolutCustomerId":"44773429-8b07-4973-b9de-3d308e86b955"},"currencyCode":"EUR","customerEmail":"a@b.com","customerFirstName":"John","customerLastName":"Smith","customerOrderCode":"ABC123","customerId":"Customer Id","deliveryAddress":{"firstName":"John","lastName":"Smith","buildingNumberOrName":"Flat 1","address1":"Victoria House","address2":"15 Apple Street","town":"Edinburgh","postcode":"BH23 6AA","country":"GB","phoneNumber":"+44 123 1110000"},"orderDescription":"Taxi fare"}},"payment-request-custom-metadata":{"summary":"Payment with custom metadata.","value":{"amount":1000,"paymentInstrument":{"type":"neteller","defaultUrl":"https://myurl.com/success/733a54a3-86d0-486c-b02a-6c3441b9a186","failedUrl":"https://myurl.com/fail/e25f065c-7727-4243-a2c8-a11e39718a95","cancelledUrl":"https://myurl.com/cancel/9f9f39a4-6b3e-440d-885c-739e41db2c9a"},"channel":"ios","billingAddress":{"firstName":"John","lastName":"Smith","buildingNumberOrName":"Flat 1","address1":"Edisonbaan","address2":"15 Apple Street","town":"Amsterdan","county":"Nieuwegein","postcode":"3439 MN","country":"NL"},"currencyCode":"EUR","customerEmail":"a@b.com","customerFirstName":"John","customerIpAddress":"123.100.100.200","customerLastName":"Smith","customerOrderCode":"ABC123","customerId":"Customer Id","customerPhoneNumber":"+44 123 1110000","customerSessionId":"123456","deliveryAddress":{"firstName":"John","lastName":"Smith","buildingNumberOrName":"Flat 1","address1":"Victoria House","address2":"15 Apple Street","town":"Edinburgh","county":"Lothian","postcode":"BH23 6AA","country":"GB","phoneNumber":"+44 123 1110000"},"orderDescription":"Taxi fare","customMetadata":{"accountAge":"2","transactionType":"Other"}}},"payment-request-tokenized-initial-mit":{"summary":"Initial payment with Tokenized Card Payment Instrument for MIT agreement.","description":"The first payment for an MIT agreement must occur with the cardholder present, be flagged as MIT and have 3-D Secure authentication enabled. Please see [Making Merchant-Initiated-Transactions (MITs) using Card-on-File](https://docs.br-dge.io/docs/vault#step-2-perform-an-initial-payment) for more information.","value":{"merchantInitiated":"unscheduled","merchantInitiatedDetails":{"initialPayment":true},"paymentInstrument":{"type":"tokenized","token":"5caa5a2a-be0b-4160-ae21-1bbbf2267f4c"},"threeDSecureRequired":true,"amount":1000,"channel":"web","origin":"https://example.com/checkout","billingAddress":{"firstName":"John","lastName":"Smith","buildingNumberOrName":"Flat 1","address1":"Victoria House","address2":"15 Apple Street","town":"Edinburgh","county":"Lothian","postcode":"BH23 6AA","country":"GB","phoneNumber":"+44 123 1110000"},"currencyCode":"GBP","customerEmail":"a@b.com","customerFirstName":"John","customerIpAddress":"123.100.100.200","customerLastName":"Smith","customerOrderCode":"ABC123","customerPhoneNumber":"+44 123 1110000","customerSessionId":"123456","orderDescription":"Taxi fare"}},"payment-request-tokenized-subsequent-mit":{"summary":"Subsequent payment with Tokenized Card Payment Instrument for MIT agreement.","description":"After entering into an MIT agreement with a cardholder, and making an intial payment with the cardholder present, subsequent MITs should be made in accordance with your agreement with the cardholder. These transactions should be linked back to the payment ID, and use the same Card-on-File, as the initial payment. Please see [Making Merchant-Initiated-Transactions (MITs) using Card-on-File](https://docs.br-dge.io/docs/vault#step-2-perform-an-initial-payment) for more information.","value":{"merchantInitiated":"recurring","merchantInitiatedDetails":{"previousPaymentId":"22669f90-5bf0-45df-ba8c-ea6d4235a5da"},"paymentInstrument":{"type":"tokenized","token":"5caa5a2a-be0b-4160-ae21-1bbbf2267f4c"},"amount":1000,"billingAddress":{"firstName":"John","lastName":"Smith","buildingNumberOrName":"Flat 1","address1":"Victoria House","address2":"15 Apple Street","town":"Edinburgh","county":"Lothian","postcode":"BH23 6AA","country":"GB","phoneNumber":"+44 123 1110000"},"currencyCode":"GBP","customerEmail":"a@b.com","customerFirstName":"John","customerLastName":"Smith","customerOrderCode":"ABC123","customerPhoneNumber":"+44 123 1110000","customerSessionId":"123456","orderDescription":"Taxi fare"}},"payment-request-psp-token":{"summary":"Payment with PSP token","description":"Tokens created with a PSP can be used to make a payment. This payment instrument does not support payment flows which require a card PAN. This includes, but is not limited to, VISA Installments and Kount\n","value":{"amount":1000,"paymentInstrument":{"type":"pspToken","token":"ABC123","psp":"Cybersource","customerId":"Customer Id","cv2":"123","tokenType":"customer"},"billingAddress":{"firstName":"John","lastName":"Smith","buildingNumberOrName":"Flat 1","address1":"Victoria House","address2":"15 Apple Street","town":"Edinburgh","county":"Lothian","postcode":"BH23 6AA","country":"GB","phoneNumber":"+44 123 1110000"},"currencyCode":"GBP","customerEmail":"a@b.com","customerFirstName":"John","customerLastName":"Smith","customerOrderCode":"ABC123","customerPhoneNumber":"+44 123 1110000","customerSessionId":"123456","orderDescription":"Taxi fare"}},"payment-request-risk-instruments":{"summary":"Payment with Risk Instruments","description":"You can optionally provide one or more Risk Instruments in payments which will be passed to the appropriate risk engine.\n","value":{"riskInstruments":{"checkoutRiskJs":{"deviceSessionId":"a-device-session-id"},"kount":{"sessionId":"a-session-id"}},"amount":1000,"paymentInstrument":{"type":"card","nameOnCard":"John F Doe","pan":"4444 3333 2222 1111","expiryDate":"01-99"},"currencyCode":"GBP","customerEmail":"a@b.com","customerFirstName":"John","customerIpAddress":"123.100.100.200","customerOrderCode":"ABC123","orderDescription":"Taxi fare"}},"payment-response-successful":{"value":{"code":"1000","message":"Approved","id":"4fad8e2e06a15656","paymentId":"22669f90-5bf0-45df-ba8c-ea6d4235a5da","psp":{"name":"Worldline Online Payments","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"},"paymentInstrument":{"type":"card"}}},"aft-payment-response-yes":{"value":{"code":"1000","message":"Approved","id":"6a688fb2bc3b49b5076d8820bfbae0e7","paymentId":"22669f90-5bf0-45df-ba8c-ea6d4235a5da","amount":1000,"currencyCode":"GBP","psp":{"name":"Checkout.com","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"},"processedAsAft":"YES"}},"payment-request-external-3ds":{"summary":"Payment with 3DS completed by an external provider","value":{"amount":1000,"paymentInstrument":{"type":"card","nameOnCard":"John F Doe","pan":"4444 3333 2222 1111","expiryDate":"01-99","startDate":"01-00","issueNumber":1,"cv2":"000"},"channel":"ios","billingAddress":{"firstName":"John","lastName":"Smith","buildingNumberOrName":"Flat 1","address1":"Victoria House","address2":"15 Apple Street","town":"Edinburgh","county":"Lothian","postcode":"BH23 6AA","country":"GB","phoneNumber":"+44 123 1110000"},"browserData":{"acceptHeader":"application/json","colorDepth":"32","javaEnabled":true,"language":"EN_en","screenHeight":768,"screenWidth":1024,"timeZone":0,"userAgent":"Mozilla/5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/67.0.3396.99 Safari/537.36"},"currencyCode":"GBP","customerEmail":"a@b.com","customerFirstName":"John","customerIpAddress":"123.100.100.200","customerLastName":"Smith","customerOrderCode":"ABC123","customerPhoneNumber":"+44 123 1110000","customerSessionId":"123456","deliveryAddress":{"firstName":"John","lastName":"Smith","buildingNumberOrName":"Flat 1","address1":"Victoria House","address2":"15 Apple Street","town":"Edinburgh","county":"Lothian","postcode":"BH23 6AA","country":"GB","phoneNumber":"+44 123 1110000"},"orderDescription":"Taxi fare","externalThreeDSecure":{"eci":"05","cavv":"O2iBgQ1Jy8xx+zALnngOggX=","xid":"oF307C8MwowbWBg+0UYqvwQ=","par":"Y","ver":"Y","dsTransactionId":"5ddb4c13-2e30-4901-9854-5f0305097a25","threeDSecureVersion":"2.1.0"}}},"payment-request-skrill":{"summary":"Payment with Skrill Payment Instrument.","description":"Note that the redirect URLs should not be easily guessable. By using unpredictable single-use URLs you can protect yourself from the possibility of bad actors attempting to make it appear that payments had a different outcome to reality. We also recommend that you confirm the outcome of payments via server-to-server calls to BR-DGE. The `customerEmail` field must be the e-mail address of the Skrill customer.\n","value":{"amount":1000,"paymentInstrument":{"type":"skrill","returnUrl":"https://example.com/success/733a54a3-86d0-486c-b02a-6c3441b9a186","pendingUrl":"https://example.com/pending/e25f065c-7727-4243-a2c8-a11e39718a95","cancelUrl":"https://example.com/cancel/9f9f39a4-6b3e-440d-885c-739e41db2c9a"},"channel":"ios","billingAddress":{"firstName":"John","lastName":"Smith","buildingNumberOrName":"Flat 1","address1":"Victoria House","address2":"15 Apple Street","town":"Edinburgh","county":"Lothian","postcode":"BH23 6AA","country":"GB","phoneNumber":"+44 123 1110000"},"currencyCode":"GBP","customerEmail":"a@b.com","customerFirstName":"John","customerIpAddress":"123.100.100.200","customerLastName":"Smith","customerOrderCode":"ABC123","customerId":"Customer Id","customerPhoneNumber":"+44 123 1110000","customerSessionId":"123456","deliveryAddress":{"firstName":"John","lastName":"Smith","buildingNumberOrName":"Flat 1","address1":"Victoria House","address2":"15 Apple Street","town":"Edinburgh","county":"Lothian","postcode":"BH23 6AA","country":"GB","phoneNumber":"+44 123 1110000"},"orderDescription":"Taxi fare"}},"payment-request-skrill-one-tap":{"summary":"Payment with Skrill 1-Tap Payment Instrument.","description":"The paymentId of the setup order must be provided within the oneTapPaymentId field.\n","value":{"amount":1000,"paymentInstrument":{"type":"skrillOneTapPayment","oneTapPaymentId":"123e4567-e89b-12d3-a456-426614174000"},"currencyCode":"GBP","customerOrderCode":"ABC123","orderDescription":"Top up account"}},"payment-request-truelayer":{"summary":"Payment with TrueLayer Payment Instrument.","description":"An example of a TrueLayer payment with all optional and mandatory fields populated. Please read the User Guide for TrueLayer for more information on required fields and the use of Signup+, Customer Verification and preselected Provider IDs.\n","value":{"amount":1000,"currencyCode":"GBP","paymentInstrument":{"type":"trueLayer","returnUrl":"http://www.return.url","providerId":"mock-payments-gb-redirect","signupPlus":false,"verifyCustomerName":true,"verifyCustomerAge":false,"countries":["GB","IE"]},"billingAddress":{"address1":"Victoria House","address2":"15 Apple Street","town":"Edinburgh","county":"Lothian","postcode":"BH23 6AA","country":"GB"},"customerEmail":"a@b.com","customerFirstName":"John","customerLastName":"Smith","customerId":"44773429-8b07-4973-b9de-3d308e86b955","customerPhoneNumber":"+44 123 1110000","customerDateOfBirth":"2024-02-24"}},"payment-request-truelayer-using-bankDetails":{"summary":"Payment with TrueLayer Payment Instrument using bank details.","description":"An example of a TrueLayer payment with the required fields to send a valid payment request using sort code and account number. Please read the User Guide for TrueLayer for more information on required fields and the use of Signup+, Customer Verification and preselected Provider IDs.\n","value":{"amount":1000,"currencyCode":"GBP","paymentInstrument":{"type":"trueLayer","returnUrl":"http://www.return.url","providerId":"mock-payments-gb-redirect","bankDetails":{"bankDetailsFormat":"GB","sortCode":"123123","accountNumber":"93945023"}},"billingAddress":{"address1":"Victoria House","address2":"15 Apple Street","town":"Edinburgh","county":"Lothian","postcode":"BH23 6AA","country":"GB"},"customerEmail":"a@b.com","customerFirstName":"John","customerLastName":"Smith","customerId":"44773429-8b07-4973-b9de-3d308e86b955","customerPhoneNumber":"+44 123 1110000","customerDateOfBirth":"2024-02-24","customerOrderCode":"ORDER0001","orderDescription":"Buying something shiny"}},"payment-request-bank2bank":{"summary":"Payment with Bank2bank Payment Instrument.","description":"Note that the redirect URLs should not be easily guessable. By using unpredictable single-use URLs you can protect yourself from the possibility of bad actors attempting to make it appear that payments had a different outcome to reality. We also recommend that you confirm the outcome of payments via server-to-server calls to BR-DGE.\n","value":{"amount":1000,"paymentInstrument":{"type":"bank2bank","bankName":"capitec","returnUrl":"https://myurl.com/return/733a54a3-86d0-486c-b02a-6c3441b9a186","identifier":{"type":"national_id","value":"2601010201187"}},"currencyCode":"ZAR","customerOrderCode":"ABC123","orderDescription":"Taxi fare"}},"payment-response-successful-rawPspResponse":{"value":{"code":"1000","message":"Approved","id":"66acd0f4c364e31c1936a2495277b42c","paymentId":"b0356312-371e-46d9-a0f6-3cb47be4b76d","actionRequired":false,"psp":{"name":"Cybersource","transactionId":"7226017166756918804951","rawPspResponses":[{"headers":{"Content-Type":["application/hal+json"]},"httpStatusCode":201,"pspName":"Cybersource","body":"{ example raw response from PSP... }"}]},"paymentInstrument":{"type":"card"}}},"payment-response-successful-included-paymentInstrument":{"value":{"code":"1000","message":"Approved","id":"4fad8e2e06a15656","paymentId":"22669f90-5bf0-45df-ba8c-ea6d4235a5da","psp":{"name":"Worldline Online Payments","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"},"relationships":{"paymentInstrument":{"data":{"id":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c6","type":"paymentInstrument"}}},"included":[{"id":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c6","type":"paymentInstrument","attributes":{"type":"googlePay","decryptedPayload":{"gatewayMerchantId":"some-merchant-id","messageExpiration":"1650574736277","messageId":"AH2Ejtc88ZHJ-2aYBQWzHwvp6l0JsCHgxVt8s91A-ZUikaXNbcjsFm6gg9ExeVR-jzIyT-mJvA_ntvfRsDDOH2jnKMjdTtXIJvPt0NBUU45R7-gnjxkx-sI0ldcWvbDHsV0735yFDbWk","paymentMethod":"CARD","paymentMethodDetails":{"pan":"####-####-####-4444","expirationMonth":5,"expirationYear":2025,"authMethod":"PAN_ONLY","eciIndicator":"07","assuranceDetails":{"accountVerified":true,"cardholderAuthenticated":true}}},"metadata":{"issuer":"ACMEBANK","type":"DEBIT","category":"CLASSIC","countryIsoA2":"GB","commercial":true,"bin":"45678765"},"expiryDate":"05-25","fingerprint":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c6","fingerprintExtended":"63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c60525"}}],"paymentInstrument":{"type":"card"}}},"payment-response-successful-apple-pay-included-paymentInstrument":{"value":{"code":"1000","message":"Approved","id":"6a956d3d069a49d46c5eae2b985b3603","paymentId":"70f4cd79-7d3b-4f88-bdd0-0e493f156ee4","psp":{"name":"Nuvei","transactionId":"7110000000028227179"},"relationships":{"paymentInstrument":{"data":{"id":"d582ba6e10f79baa3801e9fa56b148a8e98b2f7da9f85b9afa190f70bef74700","type":"paymentInstrument"}}},"included":[{"id":"d582ba6e10f79baa3801e9fa56b148a8e98b2f7da9f85b9afa190f70bef74700","type":"paymentInstrument","attributes":{"type":"applePay","metadata":{"issuer":"INTL HDQTRS-CENTER OWNED","type":"CREDIT","category":"VISA CLASSIC","countryIsoA2":"CN","commercial":false,"bin":"48185288"},"expiryDate":"01-30","fingerprint":"39100e8c5e24ddaff2deb2714403c8fe0b687e9b0a56fafd4e9eac5b13d80973","fingerprintExtended":"39100e8c5e24ddaff2deb2714403c8fe0b687e9b0a56fafd4e9eac5b13d809730130","decryptedPayload":{"applicationPrimaryAccountNumber":"4818528810104376","applicationExpirationDate":"300131","currencyCode":"826","transactionAmount":100,"deviceManufacturerIdentifier":"040010030273","paymentDataType":"3DSecure","paymentData":{"eciIndicator":7},"transactionId":"40110f5b2ddc2ae725eef131caceed8bcdf48b5795df79f0dd804e26946a98c5","cardholderName":"John Doe"},"paymentMethod":{"displayName":"Visa 0189","network":"Visa","type":"credit"}}}],"paymentInstrument":{"type":"card"}}},"payment-response-successful-cof-creation":{"description":"The token field contains a multi-use token representing the newly created Card on File.\n","value":{"code":"1000","message":"Approved","id":"4fad8e2e06a15656","paymentId":"22669f90-5bf0-45df-ba8c-ea6d4235a5da","psp":{"name":"Barclaycard ePDQ - Smartpay Checkout","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"},"token":"e2379d46-4fff-4e6f-b9af-6dab64877d60","paymentInstrument":{"type":"card"}}},"payment-response-successful-installments-plan":{"description":"The installmentsPlan field contains information about the outcome of the activated installments plan\n","value":{"code":"1000","message":"Approved","id":"4fad8e2e06a15656","paymentId":"22669f90-5bf0-45df-ba8c-ea6d4235a5da","psp":{"name":"Barclaycard Smartpay Fuse","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"},"installmentsPlan":{"provider":"Visa Installments","code":"1000","message":"Approved","planActivationId":"c58753d6-71b6-48e7-88d0-d383c0e03f69"},"token":"e2379d46-4fff-4e6f-b9af-6dab64877d60","paymentInstrument":{"type":"card"}}},"payment-response-successful-psp-token":{"description":"For retail channel configured with Vault Interoperability, the token from the PSP and the fingerprint for the card are returned for the first BR-DGE Card on File payment with this PSP\n","value":{"code":"1000","message":"Approved","id":"4fad8e2e06a15656","paymentId":"22669f90-5bf0-45df-ba8c-ea6d4235a5da","psp":{"name":"Barclaycard ePDQ - Smartpay Checkout","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c","pspToken":"src_5ormqfczt43efnx7xe2mwod4vq,","pspCardFingerprint":"C7BB2667AF7EDEA0745B8C2E8B7B68ED447711B794BA3151B3D91E2A63E40102"},"token":"e2379d46-4fff-4e6f-b9af-6dab64877d60","paymentInstrument":{"type":"pspToken"}}},"payment-response-successful-risk-assessment":{"description":"The riskAssessments field contains information about the outcome of risk assessments performed by risk engines\n","value":{"code":"1000","message":"Approved","id":"4fad8e2e06a15656","paymentId":"22669f90-5bf0-45df-ba8c-ea6d4235a5da","psp":{"name":"Worldline Online Payments","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"},"riskAssessments":{"kount":{"score":90.1,"decision":"APPROVED","transactionId":"KJX50N55NGJS","reasonCode":"APPROVED_3DS_STEP_UP","tags":["SUBSCRIPTION","KNOWN_LOCATION"]}},"paymentInstrument":{"type":"card"}}},"payment-response-successful-no-risk-engine":{"description":"The riskAssessments field contains information about the outcome of risk assessments performed by risk engines.\n\nIt is possible to configure a connection timeout for each risk engine and specify behaviour when the timeout is reached - proceed to the payment processor or decline transaction.\n\nIn this example, the configuration allows the transaction to proceed to the payment processor.\n","value":{"code":"1000","message":"Approved","id":"4fad8e2e06a15656","paymentId":"22669f90-5bf0-45df-ba8c-ea6d4235a5da","psp":{"name":"Worldline Online Payments","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"},"riskAssessments":{"kount":{"decision":"UNAVAILABLE"}},"paymentInstrument":{"type":"card"}}},"payment-response-successful-issuerResponse":{"value":{"code":"1000","message":"Approved","id":"4fad8e2e06a15656","paymentId":"22669f90-5bf0-45df-ba8c-ea6d4235a5da","customerOrderCode":"ABC123","included":[{"id":"ISSUER_1","type":"issuerResponse","attributes":{"type":"issuerResponse","issuerResponse":{"issuerPaymentMethod":"MasterCard","issuerCardType":"Debit"}}}],"relationships":{"issuerResponse":{"data":{"type":"issuerResponse","id":"ISSUER_1"}}},"psp":{"name":"Fat Zebra","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"},"paymentInstrument":{"type":"card"}}},"payment-response-accepted-3ds-further-action":{"value":{"code":"2001","message":"3D Secure action required","id":"4fad8e2e06a15656","paymentId":"22669f90-5bf0-45df-ba8c-ea6d4235a5da","psp":{"name":"Worldline Online Payments","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"},"actionRequired":true,"action":{"type":"3D_SECURE","paymentId":"22669f90-5bf0-45df-ba8c-ea6d4235a5da","data":{"clientToken":"aaabbb","verifyCardPayload":"payload","psp":"BR"}},"threeDSecureAction":{"clientToken":"aaabbb","verifyCardPayload":"payload"},"paymentInstrument":{"type":"card"}},"description":"The content of `$response.body#/action` can be passed to our [Web SDK Post Response Module] to be handled and converted into a nonce that can be used to progress the payment as a `ProviderThreeDSecureNonce` payment instrument.\n\n[Web SDK Post Response Module]: https://docs.br-dge.io/docs/post-response-module\n"},"payment-response-accepted-3ds-further-action-include-cof":{"value":{"code":"2001","message":"3D Secure action required","id":"4fad8e2e06a15656","paymentId":"22669f90-5bf0-45df-ba8c-ea6d4235a5da","psp":{"name":"Worldline Online Payments","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"},"token":"4a0f4f46-addc-4f76-8bad-5ade9e7020fb","actionRequired":true,"action":{"type":"3D_SECURE","paymentId":"22669f90-5bf0-45df-ba8c-ea6d4235a5da","data":{"clientToken":"aaabbb","verifyCardPayload":"payload","psp":"BR"}},"threeDSecureAction":{"clientToken":"aaabbb","verifyCardPayload":"payload"},"paymentInstrument":{"type":"card"}},"description":"The token field contains a multi-use token representing the newly created Card on File. Some PSPs automatically apply 3-D Secure authentication to the first payment made using a Card on File.\n\nThe content of `$response.body#/action` can be passed to our [Web SDK Post Response Module] to be handled and converted into a nonce that can be used to progress the payment as a `ProviderThreeDSecureNonce` payment instrument.\n\n[Web SDK Post Response Module]: https://docs.br-dge.io/docs/post-response-module\n"},"payment-response-accepted-pending-skrill":{"value":{"code":"2101","message":"Pending","id":"67990c0b183d9d436c4d137b8a58face","paymentId":"4155f490-bc8d-479e-83b6-acb3ab27d1dc","actionRequired":true,"action":{"type":"REDIRECT","data":{"url":"https://pay.skrill.com/wallet/checkout?sid=9dc5386e9790edce8aa0bd3459be1f4d"}},"psp":{"name":"Skrill"},"paymentInstrument":{"type":"skrill"}}},"payment-response-accepted-redirect-flow":{"value":{"code":"2101","message":"Pending: The operation has been accepted for processing and the outcome is not yet known","id":"e420b8c90d62feb3","paymentId":"fae9dad4-7bc4-4b30-a8c0-57f5f091e3b2","psp":{"name":"Trust Payments","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"},"actionRequired":true,"action":{"type":"REDIRECT","paymentId":"fae9dad4-7bc4-4b30-a8c0-57f5f091e3b2","data":{"errorUrl":"https://myurl.com/success?bridgePaymentId=fae9dad4-7bc4-4b30-a8c0-57f5f091e3b2","provider":"IDEAL","providerTransactionId":"58-86-168300","successUrl":"https://myurl.com/success?bridgePaymentId=fae9dad4-7bc4-4b30-a8c0-57f5f091e3b2","url":"https://r3.girogate.de/ti/dumbdummy?tx=902589716&rs=ziwUjfJ3DyYq2OfvhCvwTzm2yBUp27VK"}},"pspId":"TRUST","paymentInstrument":{"type":"trustly"}},"description":"The content of `$response.body#/action` can be passed to our [Web SDK Post Response Module] which will handle the redirect for you.\n\nSome [Payment Instruments] use the [BR-DGE Redirect Payment Flow] which require shoppers to be redirected to a third party URL.\n\nThe above example shows the data returned for iDEAL, but the action data will vary depending between Payment Instruments.\n\n[Web SDK Post Response Module]: https://docs.br-dge.io/docs/post-response-module\n[Payment Instruments]: https://docs.br-dge.io/docs/introduction#payment-instrument\n[BR-DGE Redirect Payment Flow]: https://docs.br-dge.io/docs/payment-flows#redirect-payment-flow\n"},"payment-response-accepted-pending":{"value":{"code":"2101","message":"Pending - The operation has been accepted for processing and the outcome is not yet known","id":"4fad8e2e06a15656","status":"AUTHORIZATION_PENDING","psp":{"name":"Worldline Online Payments","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"},"paymentInstrument":{"type":"card"}}},"payout-request-true-layer-paymentsource":{"summary":"Payout request with the TrueLayer payment source flow.","description":"TrueLayer payout using a Payment Source ID Required Fields:\n  - recipient.customerId\n","value":{"psp":"TrueLayer","amount":100,"currencyCode":"GBP","recipient":{"firstName":"John","ipAddress":"123.100.100.200","customerId":"Customer001","lastName":"Smith"},"paymentInstrument":{"type":"trueLayer","paymentSource":{"paymentSourceId":"41b500a4-5379-4f30-9eda-2fcc032afc37"}},"reference":"abc123","purpose":"leisure"}},"payout-request-true-layer-scan":{"summary":"Payout request with the TrueLayer SCAN flow","description":"Create a payout with TrueLayer using Sort Code and Account Number. Required fields:\n  - recipient.firstName\n  - recipient.lastName\n  - recipient.customerId\n\n\nIf the clients transactions are subject to sanctions screening, then the address must be provided, otherwise it is optional. Specifically address.address1, address.town, address.postcode and address.country.\n","value":{"psp":"TrueLayer","amount":100,"currencyCode":"GBP","recipient":{"firstName":"John","ipAddress":"123.100.100.200","customerId":"Customer001","lastName":"Smith"},"paymentInstrument":{"type":"trueLayer","bankDetails":{"bankDetailsFormat":"GB","accountNumber":"93945023","sortCode":"400040"}},"reference":"abc123","purpose":"leisure"}},"payout-request-true-layer-iban":{"summary":"Payout request with the TrueLayer IBAN flow","description":"Make a TrueLayer payout using International Bank Account Number Required fields:\n  - recipient.firstName\n  - recipient.lastName\n\n\nIf the client's transactions are subject to sanctions screening, then the address must be provided, otherwise it is optional. Specifically address.address1, address.town, address.postcode and address.country.\n","value":{"psp":"TrueLayer","amount":100,"currencyCode":"GBP","recipient":{"firstName":"John","ipAddress":"123.100.100.200","lastName":"Smith"},"paymentInstrument":{"type":"trueLayer","bankDetails":{"bankDetailsFormat":"IBAN","iban":"GB32CLRB04066800012315"}},"reference":"abc123","purpose":"leisure"}},"payout-request-true-layer-user-determined":{"summary":"Payout request with the TrueLayer user defined flow","description":"Make a TrueLayer payout which returns a redirect URL for the client to follow through. Required fields:\n  - recipient.firstName\n  - recipient.lastName\n  - recipient.customerId\n  - either recipient.email OR recipient.phoneNumber\n\n\nIf the client's transactions are subject to sanctions screening, then the address must be provided, otherwise it is optional. Specifically address.address1, address.town, address.postcode and address.country.\n","value":{"psp":"TrueLayer","amount":100,"currencyCode":"GBP","recipient":{"firstName":"John","ipAddress":"123.100.100.200","customerId":"Customer001","email":"test@gmx.co.uk","lastName":"Smith"},"paymentInstrument":{"type":"trueLayer","verification":{"providerId":"mock-payments-gb-redirect","returnUrl":"http://www.return.url","verificationDetails":{"searchTokens":["foo","loooooooongerToken","0213121"],"amount":100,"currencyCode":"GBP","paymentDate":"2025-04-23"}}},"reference":"abc123","purpose":"leisure"}},"payout-response-true-layer":{"summary":"TrueLayer Payout Approved","description":"Approved payout response with no redirect url. Non-user determined flow.","value":{"code":"1000","message":"Approved","id":"682eec9524eef524cfdc7c2db083d16b","paymentId":"49769bcd-2d13-4d83-8427-7184f290fd6f","psp":{"name":"TrueLayer","transactionId":"1f111d3c-9427-43be-1111-1111219d111c"},"paymentInstrument":{"type":"trueLayer"}}},"payout-response-true-layer-user-determined":{"summary":"TrueLayer Payout Pending - With Redirect","description":"Approved payout response with redirect url. Outcome of theUser determined flow.","value":{"code":"2101","message":"Pending - The operation has been accepted for processing and the outcome is not yet known. If an action is in the response, please see post-response actions, otherwise see callbacks","id":"682eec9524eef524cfdc7c2db083d16b","paymentId":"49769bcd-2d13-4d83-8427-7184f290fd6f","psp":{"name":"TrueLayer","transactionId":"1f111d3c-9427-43be-1111-1111219d111c"},"actionRequired":true,"action":{"type":"REDIRECT","data":{"redirectUrl":"https://br-dge.to/redirect","status":"authorization_required","providerTransactionId":"ee83e92a-efde-4a4c-b964-855301ed588f"}},"paymentInstrument":{"type":"trueLayer"}}},"payout-request-worldpayAccessBankPayout-IBAN":{"summary":"Payout request with the Access Worldpay Bank Payout flow using IBAN-based bank details","description":"Make an Access Worldpay cross-border payout using International Bank Account Number\n","value":{"psp":"Access Worldpay","amount":100,"currencyCode":"GBP","recipient":{"title":"Mr","firstName":"John","lastName":"Smith","address":{"country":"GB"}},"paymentInstrument":{"type":"accessWorldpay","bankDetails":{"bankDetailsFormat":"IBAN","iban":"GB32CLRB04066800012315","swiftBic":"CITIGB2L","bankName":"Citibank London"}},"reference":"abc123"}},"payout-request-worldpayAccessBankPayout-GB":{"summary":"Payout request with the Access Worldpay Bank Payout flow using GB-based bank details","description":"Make an Access Worldpay payout using sort code and account number\n","value":{"psp":"Access Worldpay","amount":100,"currencyCode":"GBP","recipient":{"title":"Mr","firstName":"John","lastName":"Smith","address":{"country":"GB"}},"paymentInstrument":{"type":"accessWorldpay","bankDetails":{"bankDetailsFormat":"GB","bankName":"Citibank London","accountNumber":"18404100","sortCode":"185008"}},"reference":"abc123"}},"bad-request-with-validation-errors":{"description":"This example shows the [4030203] and [4030301] **Validation Errors**.\n\nA full list of possible validation errors are available [here].\n\n[4030203]: https://docs.br-dge.io/docs/validation-errors#4030203\n[4030301]: https://docs.br-dge.io/docs/validation-errors#4030301\n[here]: https://docs.br-dge.io/docs/validation-errors\n","value":{"code":"4000","message":"Invalid request","id":"4fad8e2e06a15656","validationErrors":{"paymentInstrument.pan":"4030203 - The value entered for Pan is incorrect. It is not a valid card PAN.","paymentInstrument.expiryDate":"4030301 - Expiry Date cannot be blank."}}},"bad-request-payment-declined-risk-assessment":{"description":"This example shows the [4260] **Transaction Error**.\n\nA full list of possible transaction errors is available [here].\n\n[4260]: https://docs.br-dge.io/docs/response-codes#4260\n[here]: https://docs.br-dge.io/docs/response-codes#4200\n","value":{"code":"4260","message":"High risk","id":"4fad8e2e06a15656","riskAssessments":{"kount":{"score":40.2,"decision":"DECLINED","transactionId":"KJX50N55NGJS","tags":["NEW_DEVICE","NEW_LOCATION"]}}}},"authorization-pending":{"summary":"Payment Authorization Pending","description":"A transaction has been submitted for Authorization to the Processor and this request has been accepted by the Processor but the outcome has not been determined.\n","value":{"type":"payment","id":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","merchantAccountId":"aadf8010-4df3-49c6-96c0-9f175f60ef36","merchantTransactionId":"a8876gha-ph67-67fg-js06-2ad06sk9fp7c","code":"1000","message":"Approved","status":"AUTHORIZATION_PENDING","psp":{"name":"Barclaycard Smartpay Fuse","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c","message":"{\"example\": \"psp-response\"}"},"hashCode":"90c3b3881074021383c8679f0232580f7b96cebacab77517fc4b479e6d977b06","customerOrderCode":"ABC23"}},"authorized":{"summary":"Payment Authorized","description":"A transaction has been submitted for Authorization to the Processor and this request has been processed and Authorized. The transaction is now available to be included in a Capture request. Where the merchant is enrolled for auto capture with the Processor, the transaction status will be set directly to `CAPTURED`","value":{"type":"payment","id":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","merchantAccountId":"aadf8010-4df3-49c6-96c0-9f175f60ef36","merchantTransactionId":"a8876gha-ph67-67fg-js06-2ad06sk9fp7c","code":"1000","message":"Approved","status":"AUTHORIZED","psp":{"name":"Barclaycard Smartpay Fuse","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c","message":"{\"example\": \"psp-response\"}"},"hashCode":"90c3b3881074021383c8679f0232580f7b96cebacab77517fc4b479e6d977b06","customerOrderCode":"ABC23"}},"authorized-payment-instrument-card":{"summary":"Payment Authorized - Including extended paymentInstrument information - Card","description":"Similar to the \"Authorized\" example, however this also includes additional information regarding the payment instrument used to make the payment. This paymentInstrument schema depends on the type of paymentInstrument used to create the payment. This example is a regular card payment. These fields are also present for Apple Pay and Google Pay payments.","value":{"type":"payment","id":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","merchantAccountId":"aadf8010-4df3-49c6-96c0-9f175f60ef36","merchantTransactionId":"a8876gha-ph67-67fg-js06-2ad06sk9fp7c","code":"1000","message":"Approved","status":"AUTHORIZED","psp":{"name":"Barclaycard Smartpay Fuse","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c","message":"{\"example\": \"psp-response\"}"},"relationships":{"paymentInstrument":{"data":{"id":"7fd75cf4e8d9597739ee0df49c91804978859f6c088477f3ad2231f5820096ba","type":"paymentInstrument"}}},"included":[{"id":"7fd75cf4e8d9597739ee0df49c91804978859f6c088477f3ad2231f5820096ba","type":"paymentInstrument","attributes":{"type":"card","metadata":{"cardBrand":"VISA","type":"DEBIT","category":"VISA CLASSIC","countryIsoA2":"PL","commercial":false},"expiryDate":"11-99","fingerprint":"7fd75cf4e8d9597739ee0df49c91804978859f6c088477f3ad2231f5820096ba","fingerprintExtended":"7fd75cf4e8d9597739ee0df49c91804978859f6c088477f3ad2231f5820096ba1199"}}],"hashCode":"90c3b3881074021383c8679f0232580f7b96cebacab77517fc4b479e6d977b06","customerOrderCode":"ABC23"}},"authorized-payment-instrument-apple-pay":{"summary":"Payment Authorized - Including extended paymentInstrument information - Apple Pay","description":"Similar to the \"Authorized\" example, however this also includes additional information regarding the payment instrument used to make the payment. This paymentInstrument schema depends on the type of paymentInstrument used to create the payment. This example is an Apple Pay payment.","value":{"type":"payment","id":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","merchantAccountId":"aadf8010-4df3-49c6-96c0-9f175f60ef36","merchantTransactionId":"a8876gha-ph67-67fg-js06-2ad06sk9fp7c","code":"1000","message":"Approved","status":"AUTHORIZED","psp":{"name":"Barclaycard Smartpay Fuse","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c","message":"{\"example\": \"psp-response\"}"},"relationships":{"paymentInstrument":{"data":{"id":"7fd75cf4e8d9597739ee0df49c91804978859f6c088477f3ad2231f5820096ba","type":"paymentInstrument"}}},"included":[{"id":"7fd75cf4e8d9597739ee0df49c91804978859f6c088477f3ad2231f5820096ba","type":"paymentInstrument","attributes":{"type":"applePay","metadata":{"cardBrand":"VISA","type":"DEBIT","category":"VISA CLASSIC","countryIsoA2":"PL","commercial":false},"decryptedPayload":{"applicationPrimaryAccountNumber":"4111111111111111","applicationExpirationDate":"301299","currencyCode":"826","transactionAmount":100,"deviceManufacturerIdentifier":"1234567890","paymentDataType":"3DSecure","paymentData":{"eciIndicator":7},"transactionId":"abcdef1234567890","cardholderName":"John Doe"},"paymentMethod":{"displayName":"MasterCard 0839","network":"MasterCard","type":"credit"},"expiryDate":"11-99","fingerprint":"7fd75cf4e8d9597739ee0df49c91804978859f6c088477f3ad2231f5820096ba","fingerprintExtended":"7fd75cf4e8d9597739ee0df49c91804978859f6c088477f3ad2231f5820096ba1199"}}],"hashCode":"90c3b3881074021383c8679f0232580f7b96cebacab77517fc4b479e6d977b06","customerOrderCode":"ABC23"}},"authorized-payment-instrument-google-pay":{"summary":"Payment Authorized - Including extended paymentInstrument information - Google Pay","description":"Similar to the \"Authorized\" example, however this also includes additional information regarding the payment instrument used to make the payment. This paymentInstrument schema depends on the type of paymentInstrument used to create the payment. This example is an Google Pay payment. Note that for Google Pay payments that use PAN_ONLY, the `pan` returned will be obfuscated.","value":{"type":"payment","id":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","merchantAccountId":"aadf8010-4df3-49c6-96c0-9f175f60ef36","merchantTransactionId":"a8876gha-ph67-67fg-js06-2ad06sk9fp7c","code":"1000","message":"Approved","status":"AUTHORIZED","psp":{"name":"Barclaycard Smartpay Fuse","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c","message":"{\"example\": \"psp-response\"}"},"relationships":{"paymentInstrument":{"data":{"id":"7fd75cf4e8d9597739ee0df49c91804978859f6c088477f3ad2231f5820096ba","type":"paymentInstrument"}}},"included":[{"id":"7fd75cf4e8d9597739ee0df49c91804978859f6c088477f3ad2231f5820096ba","type":"paymentInstrument","attributes":{"type":"googlePay","metadata":{"cardBrand":"VISA","type":"DEBIT","category":"VISA CLASSIC","countryIsoA2":"PL","commercial":false},"decryptedPayload":{"gatewayMerchantId":"my-merchant","messageExpiration":"1234567890","messageId":"my-message-id","paymentMethod":"CARD","paymentMethodDetails":{"pan":"####-####-####-1111","expirationMonth":12,"expirationYear":2099,"cardLastFour":"1111","authMethod":"PAN_ONLY","eciIndicator":"07","assuranceDetails":{"accountVerified":true,"cardholderAuthenticated":false}}},"expiryDate":"11-99","fingerprint":"7fd75cf4e8d9597739ee0df49c91804978859f6c088477f3ad2231f5820096ba","fingerprintExtended":"7fd75cf4e8d9597739ee0df49c91804978859f6c088477f3ad2231f5820096ba1199"}}],"hashCode":"90c3b3881074021383c8679f0232580f7b96cebacab77517fc4b479e6d977b06","customerOrderCode":"ABC23"}},"capture-pending":{"summary":"Payment Capture Pending","description":"An authorized transaction has been submitted for capture and this request has been accepted by the processor but the outcome has not been determined.\n","value":{"type":"payment","id":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","merchantAccountId":"aadf8010-4df3-49c6-96c0-9f175f60ef36","merchantTransactionId":"a8876gha-ph67-67fg-js06-2ad06sk9fp7c","code":"1002","message":"Capture pending","status":"CAPTURE_PENDING","psp":{"name":"Barclaycard Smartpay Fuse","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c","message":"{\"example\": \"psp-response\"}"},"hashCode":"90c3b3881074021383c8679f0232580f7b96cebacab77517fc4b479e6d977b06","customerOrderCode":"ABC23"}},"captured":{"summary":"Payment Captured","description":"An authorized transaction has been submitted for capture and this request has been accepted and confirmed by the processor.\n","value":{"type":"payment","id":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","merchantAccountId":"aadf8010-4df3-49c6-96c0-9f175f60ef36","merchantTransactionId":"a8876gha-ph67-67fg-js06-2ad06sk9fp7c","code":"1000","message":"Approved","status":"CAPTURED","psp":{"name":"Barclaycard Smartpay Fuse","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c","message":"{\"example\": \"psp-response\"}"},"hashCode":"90c3b3881074021383c8679f0232580f7b96cebacab77517fc4b479e6d977b06","customerOrderCode":"ABC23","notificationMetadata":{"source":"PSP_WEBHOOK","entity":"PAYMENT","eventTimestamp":1734000000000}}},"declined":{"summary":"Payment Declined","description":"A transaction has been submitted for Authorization to the Processor and this request has been processed and declined. The transaction could have been declined by the Processor due to rules within their system [Fraud, velocity limits, value limits] or by the Card Issuer. There will be an associated “reason” assigned to this state providing details of the decline.\n","value":{"type":"payment","id":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","merchantAccountId":"aadf8010-4df3-49c6-96c0-9f175f60ef36","merchantTransactionId":"a8876gha-ph67-67fg-js06-2ad06sk9fp7c","code":"4202","message":"Insufficient funds","status":"DECLINED","psp":{"name":"Barclaycard Smartpay Fuse","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c","message":"{\"example\": \"psp-response\"}"},"hashCode":"90c3b3881074021383c8679f0232580f7b96cebacab77517fc4b479e6d977b06","customerOrderCode":"ABC23"}},"rejected":{"summary":"Payment Rejected","description":"A transaction has been submitted for Authorization to the processor and this been rejected due to a validation or a technical error. This rejection may have occurred within the BR-DGE platform, the Processor or the Card Issuer. There will be an associated “reason” assigned to this state providing details of the rejection.\n","value":{"type":"payment","id":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","merchantAccountId":"aadf8010-4df3-49c6-96c0-9f175f60ef36","merchantTransactionId":"a8876gha-ph67-67fg-js06-2ad06sk9fp7c","code":"4104","message":"Set up error","status":"REJECTED","psp":{"name":"Barclaycard Smartpay Fuse","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c","message":"{\"example\": \"psp-response\"}"},"hashCode":"90c3b3881074021383c8679f0232580f7b96cebacab77517fc4b479e6d977b06","customerOrderCode":"ABC23"}},"capture-failed":{"summary":"Payment Capture Failed","description":"A transaction has been submitted for authorization to the processor and this request has been processed and failed. There will be an associated “reason” assigned to this state providing details of the failure.\n","value":{"type":"payment","id":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","merchantAccountId":"aadf8010-4df3-49c6-96c0-9f175f60ef36","merchantTransactionId":"a8876gha-ph67-67fg-js06-2ad06sk9fp7c","code":"4252","message":"Maximum retries reached","status":"CAPTURE_FAILED","psp":{"name":"Checkout.com","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c","message":"{\"error\": \"Transaction Error: Maximum number of attempts to process request reached\"}"},"hashCode":"90c3b3881074021383c8679f0232580f7b96cebacab77517fc4b479e6d977b06","customerOrderCode":"ABC23"}},"captured-paysafecard":{"summary":"Payment Captured for Paysafecard","description":"An authorized transaction has been submitted for capture and this request has been accepted and confirmed by the processor.\n","value":{"type":"payment","id":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","merchantAccountId":"aadf8010-4df3-49c6-96c0-9f175f60ef36","merchantTransactionId":"a8876gha-ph67-67fg-js06-2ad06sk9fp7c","code":"1000","message":"Approved","status":"CAPTURED","psp":{"name":"Paysafecard","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c","additionalInfo":{"type":"paysafecard","customerFirstName":"John","customerLastName":"Smith","customerDateOfBirth":"2000-01-01","customerIpAddress":"0.0.0.0","customerId":"d94d2b0e-6d76-49c8-ab1f-88d1209a8c1b","paysafecardCustomerId":"151743187547"}},"hashCode":"90c3b3881074021383c8679f0232580f7b96cebacab77517fc4b479e6d977b06","customerOrderCode":"ABC23"}},"voided":{"summary":"Payment Voided Status","value":{"type":"payment","merchantAccountId":"aadf8010-4df3-49c6-96c0-9f175f60ef36","merchantTransactionId":"a8876gha-ph67-67fg-js06-2ad06sk9fp7c","id":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","code":"1000","message":"Approved","status":"VOIDED","psp":{"name":"Trust Payments","transactionId":"a83a53a2-dcc8-45be-bf70-2b1e4b719f7c","message":"{\"example\": \"psp-response\"}"},"hashCode":"90c3b3881074021383c8679f0232580f7b96cebacab77517fc4b479e6d977b06","customerOrderCode":"ABC23"}},"entity-not-found":{"summary":"Entity Not Found Error","description":"This example shows the [4040 error code].\nThis occurs when an entity was not found for a given ID, the entity should be clear from context.\nA full list of possible response codes is available [here].\n\n[4040 error code]: https://docs.br-dge.io/docs/response-codes#4040\n[here]: https://docs.br-dge.io/docs/response-codes\n","value":{"code":"4040","message":"Entity not found","id":"4fad8e2e06a15656"}}},"responses":{"BadRequest":{"description":"Bad request - the request was in an invalid format or contained invalid information.\n\nIf have any questions about why you are receiving these responses, please raise a ticket with support on the BR-DGE Support Portal at <https://docs.br-dge.io/docs/support#contact-support> with the `id` from the response so we track down the individual requests on our end.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"Bad request with validation errors":{"$ref":"#/components/examples/bad-request-with-validation-errors"}}}}},"UnauthorizedRequest":{"description":"Unauthorized request."},"UnknownServerError":{"description":"An internal server error occurred upstream while processing the request.\nIf you have any questions about why you are receiving these responses, please raise a ticket with support on the BR-DGE Support Portal at <https://docs.br-dge.io/docs/support#contact-support> with the ID from the response so we track down the individual requests on our end.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"Internal server error":{"description":"This example shows the [5001 error code].\n\nA full list of possible response codes is available [here].\n\n[5001 error code]: https://docs.br-dge.io/docs/response-codes#5001\n[here]: https://docs.br-dge.io/docs/response-codes\n","value":{"code":"5001","message":"Unexpected error","id":"4fad8e2e06a15656"}}}}}},"UnprocessableContentRequest":{"description":"Unprocessable Content - The server understood the content type of the request, and the syntax of the request content was correct, but it was unable to process.\n\nThis scenario can occur when a payment could not be routed to a PSP, for example if the payment was blocked during routing or no PSP config is set up. It is not a bad request as it has passed gateway validation.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentResponse"},"examples":{"No PSP config to be routed to":{"value":{"code":"5004","message":"PSP config error","id":"6786339ad572b9a41bafcd00dd49aee7","paymentId":"b8297e3f-98ec-46d4-ba67-8746a71e8ed1","actionRequired":false,"pspId":"SERVER","customerOrderCode":"ABC123"}},"Transaction was blocked by routing rules":{"value":{"code":"4805","message":"Blocked by Routing Rules","id":"69ef64e18ee71062fe94b6d14d334d6e","paymentId":"306f9ee1-a79b-4fdc-835f-0253ad80397a","amount":10,"currencyCode":"GBP","actionRequired":false,"pspId":"SERVER","customerOrderCode":"ABC123","blockingRule":{"name":"Block amounts greater than 100 GBP"}}}}}}},"BadGatewayNetworkError":{"description":"An error occurred upstream while processing the request, possibly on payment processor.\n\nIf have any questions about why you are receiving these responses, please raise a ticket with support on the BR-DGE Support Portal at <https://docs.br-dge.io/docs/support#contact-support> with the ID from the response so we track down the individual requests on our end.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"Payment processor network error":{"description":"This example shows the [5301 error code].\n\nA full list of possible response codes is available [here].\n\n[5301 error code]: https://docs.br-dge.io/docs/response-codes#5301\n[here]: https://docs.br-dge.io/docs/response-codes\n","value":{"code":"5301","message":"Network error on processor","id":"4fad8e2e06a15656","psp":{"name":"Cybersource"}}}}}}},"CallbackSuccessfulResponse":{"description":"Your server returns this code if it accepts the callback"},"EntityNotFound":{"description":"The specified entity was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"entity-not-found":{"$ref":"#/components/examples/entity-not-found"}}}}},"PayoutUnprocessableContentRequest":{"description":"Unprocessable Content - The server understood the content type of the request, and the syntax of the request content was correct, but it was unable to process.\n\nThis scenario can occur when a payout could not be routed to a PSP, for example if the payout was blocked during routing. It is not a bad request as it has passed gateway validation.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutResponse"},"examples":{"Transaction was blocked by routing rules":{"value":{"code":"4805","id":"69ef64e18ee71062fe94b6d14d334d6e","message":"Blocked by Routing Rules","paymentId":"306f9ee1-a79b-4fdc-835f-0253ad80397a","payoutEligibility":{"crossBorderGambling":"UNKNOWN","crossBorderMoneyTransfer":"UNKNOWN","crossBorderNonMoneyTransfer":"UNKNOWN","domesticGambling":"UNKNOWN","domesticMoneyTransfer":"UNKNOWN","domesticNonMoneyTransfer":"UNKNOWN"},"amount":10,"currencyCode":"GBP","blockingRule":{"name":"Block amounts greater than 100 GBP"}}}}}}}},"callbacks":{"PspTokenStatusChangeEvent":{"https://example.com/BR-DGE/ as defined in your retail channel config":{"post":{"description":"When BR-DGE provisions a PSP token it will generally enter an ACTIVE state indicating that it can be used in transactions with the PSP.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PspTokenStatusChangeCallback"},"example":{"type":"token.psp.statusChange","merchantAccountId":"aadf8010-4df3-49c6-96c0-9f175f60ef36","token":"67d6c053-acba-48d5-86c2-0173b2b6d4be","code":"1000","message":"PSP Token provisioned","psp":{"name":"Checkout.com","tokenId":"src_5ormqfczt43efnx7xe2mwod4vq","pspCardFingerprint":"C7BB2667AF7EDEA0745B8C2E8B7B68ED447711B794BA3151B3D91E2A63E40102","status":"ACTIVE","additionalData":{"customerToken":"20C17E0D04D14D26E063A2598D0A4024","instrumentIdentifierToken":"7010000000016241111"}},"id":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c"}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"PspTokenProvisioningFailedEvent":{"https://example.com/BR-DGE/ as defined in your retail channel config":{"post":{"description":"Information on a failed attempt to provision a Vault Interoperability PSP Token.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PspTokenProvisioningFailureCallback"},"example":{"type":"token.psp.provisioning.failed","merchantAccountId":"aadf8010-4df3-49c6-96c0-9f175f60ef36","token":"67d6c053-acba-48d5-86c2-0173b2b6d4be","code":"4207","message":"Invalid expiration date","psp":{"name":"Checkout.com"}}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"NetworkTokenProvisioningFailedEvent":{"https://example.com/BR-DGE/ as defined in your retail channel config":{"post":{"description":"An unsuccessful attempt was made to provision a Network Token for a BR-DGE Card-on-File.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkTokenProvisioningFailedCallback"},"example":{"type":"token.network.provisioning.failed","merchantAccountId":"aadf8010-4df3-49c6-96c0-9f175f60ef36","code":"9006","message":"Notification: Network Token provisioning has failed.","hashCode":"90c3b3881074021383c8679f0232580f7b96cebacab77517fc4b479e6d977b06","token":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","customerId":"customer-1234"}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"NetworkTokenStatusChangeEvent":{"https://example.com/BR-DGE/ as defined in your retail channel config":{"post":{"description":"The Network Token has changed state.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkTokenStatusChangeCallback"},"examples":{"active-network-token":{"summary":"Network Token entered an active state","description":"Cryptograms can be provisioned for active Network Tokens.\nBR-DGE will automatically provision Cryptograms for payments made through BR-DGE or you can provision cryptograms directly via `POST /payment-instruments/{token}/network-token-cryptogram` if this feature is enabled on your retail channel.\n","value":{"type":"token.network.statusChange","merchantAccountId":"aadf8010-4df3-49c6-96c0-9f175f60ef36","token":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","customerId":"customer-1234","status":"Network Token activated","networkToken":{"token":"WXdfRANqUrBalltlBKaaWHVGrFoWrIHsZAK","status":"ACTIVE","issuer":"Visa","paymentAccountReference":"V00asd62"},"code":"9000","message":"Notification: Network Token has been activated."}},"disabled-network-token":{"summary":"Network Token entered a disabled state","description":"The Network Token has been temporarily disabled. It won't be possible to provision cryptograms until it moves back into an active state.\n","value":{"type":"token.network.statusChange","merchantAccountId":"aadf8010-4df3-49c6-96c0-9f175f60ef36","hashCode":"90c3b3881074021383c8679f0232580f7b96cebacab77517fc4b479e6d977b06","token":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","customerId":"customer-1234","status":"Network Token disabled","networkToken":{"token":"WXdfRANqUrBalltlBKaaWHVGrFoWrIHsZAK","status":"DISABLED","issuer":"Mastercard","paymentAccountReference":"V00asd62"},"code":"9001","message":"Notification: Network Token has been disabled."}},"deleted-network-token":{"summary":"Network Token deleted","description":"The Network Token has been permanently deleted.","value":{"type":"token.network.statusChange","merchantAccountId":"aadf8010-4df3-49c6-96c0-9f175f60ef36","token":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","customerId":"customer-1234","status":"Network Token deleted","networkToken":{"token":"WXdfRANqUrBalltlBKaaWHVGrFoWrIHsZAK","status":"DELETED","issuer":"Visa","paymentAccountReference":"V00asd62"},"code":"9002","message":"Notification: Network Token has been deleted."}}}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"NetworkTokenMetadataUpdateEvent":{"https://example.com/BR-DGE/ as defined in your retail channel config":{"post":{"description":"The Network Token has had metadata updated that you can access via `GET /payment-instruments`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkTokenMetadataUpdateCallback"},"example":{"type":"token.network.metadataUpdate","merchantAccountId":"aadf8010-4df3-49c6-96c0-9f175f60ef36","code":"9003","message":"Notification: Network Token metadata has been updated.","hashCode":"90c3b3881074021383c8679f0232580f7b96cebacab77517fc4b479e6d977b06","token":"c2fcf424-d7df-4b8b-aa98-3a60ce990d7c","customerId":"customer-1234","networkToken":{"token":"WXdfRANqUrBalltlBKaaWHVGrFoWrIHsZAK","status":"ACTIVE","issuer":"Visa","isCardArtUpdated":true,"paymentAccountReference":"V00asd62","lastFour":"0149","cardBin":"001234","cardLastFour":"1234","cardExpiryDate":"12-34","cardIssuer":"Bank of BR-DGE"}}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"PaymentInstrumentAccountSelectionEvent":{"https://example.com/BR-DGE/ as defined in your retail channel config":{"post":{"description":"This webhook is triggered when a user selects an account. Account selection can happen during payments, account verifications and registrations.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentInstrumentAccountSelectionCallback"},"example":{"type":"paymentInstrument.account","merchantAccountId":"aadf8010-4df3-49c6-96c0-9f175f60ef36","code":"1004","message":"Account has been selected for payment.","customerId":"customer-1234","source":"PAYMENT","reference":"81f7baee-2955-4fee-8d6f-289f8579b360","psp":{"name":"Trustly","transactionId":"3473567567","message":"{\"example\": \"psp-response\"}"},"account":{"type":"trustly","accountId":"1234567890","bank":"Barclays","town":"PaloAlto","name":"John Mockington","address":"LincolnDrive","postcode":"456","descriptor":"**926819","lastDigits":"926819","clearingHouse":"UNITED_KINGDOM","verified":true},"hashCode":"90c3b3881074021383c8679f0232580f7b96cebacab77517fc4b479e6d977b06"}}}},"responses":{"200":{"$ref":"#/components/responses/CallbackSuccessfulResponse"}}}}},"PaymentStatusChangeEvent":{"https://example.com/BR-DGE/ as defined in your retail channel config":{"post":{"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentStatusChangeEvent"},"examples":{"capture-pending":{"$ref":"#/components/examples/capture-pending"},"captured":{"$ref":"#/components/examples/captured"},"captured-paysafecard":{"$ref":"#/components/examples/captured-paysafecard"},"capture-failed":{"$ref":"#/components/examples/capture-failed"},"voided":{"$ref":"#/components/examples/voided"}}}}},"responses":{"200":{"$ref":"#/components/responses/CallbackSuccessfulResponse"}}}}}}}}