# Internal Payments

## POST /v1/partner/payments/customers/{customerId}/payments/internal

> Create internal payment

```json
{"openapi":"3.0.0","info":{"title":"Horizon Link - API Docs","version":"1.0"},"servers":[{"url":"api-url"}],"paths":{"/v1/partner/payments/customers/{customerId}/payments/internal":{"post":{"operationId":"PaymentController_createInternalPayment","summary":"Create internal payment","parameters":[{"name":"customerId","required":true,"in":"path","schema":{"type":"string"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerPaymentInternalPayload"}}}},"responses":{"200":{"description":"Returns payment id to be used in the next step","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerPaymentResponse"}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"404":{"description":"Account Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"412":{"description":"Modulus / IBAN error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerPaymentErrorResponse"}}}}},"tags":["Payments"]}}},"components":{"schemas":{"PartnerPaymentInternalPayload":{"type":"object","properties":{"sourceAccountId":{"type":"string","description":"Account id of the source account from which payment is sent","format":"uuid"},"destinationAccountId":{"type":"string","description":"Account id of the destination account which receiving the payment","format":"uuid"},"idempotencyKey":{"type":"string","description":"Unique key to ensure idempotency of payment requests","format":"uuid"},"amount":{"type":"number","description":"Amount in minor units (e.g. for £1.29 enter 129)"},"externalReference":{"type":"string","description":"Reference identifier provided by partner.","format":"uuid"},"description":{"type":"string","description":"Description of the payment","maxLength":140,"nullable":true},"verificationMetadata":{"description":"Metadata required to verify the payment request","allOf":[{"$ref":"#/components/schemas/PartnerPaymentVerificationMetadata"}]},"purpose":{"type":"string","description":"Purpose of the payment","enum":["UNKNOWN","PAYING_FAMILY_OR_FRIEND","TRANSFER_OWN_OTHER_BANK_ACCOUNT","BUY_SOMETHING","PAY_INVOICE","SALARY_OR_WAGES","GOVERNMENT_PAYMENT","TAX_PAYMENT","LOAN_REPAYMENT","BUYING_HOME_OR_PAYING_SOLICITOR","PAYING_BUILDER_OR_TRADESPERSON","INVESTMENTS","PAYING_RENT","CHARITABLE_DONATION","OTHER","TREASURY_PAYMENT","TREASURY_NETTING","CARD_SCHEME_SETTLEMENT","GENERIC_FEES","SAVINGS_PAYMENT","GIFT_PAYMENT"],"nullable":true}},"required":["sourceAccountId","destinationAccountId","idempotencyKey","amount","externalReference","verificationMetadata"]},"PartnerPaymentVerificationMetadata":{"type":"object","properties":{"verificationType":{"type":"string","description":"Type of verification applied.","enum":["BIOMETRIC_VERIFIED","DEVICE_VERIFIED","SMS_OTP_VERIFIED","VOICE_OTP_VERIFIED","WHATSAPP_OTP_VERIFIED","EMAIL_OTP_VERIFIED","AGENT_VERIFIED"],"nullable":true},"verificationReference":{"type":"string","description":"Reference identifier for the verification.","nullable":true},"exemptionType":{"type":"string","description":"Exemption type applied to the payment verification.","enum":["LOW_VALUE","NOMINATED_COUNTERPARTY","RECURRING_PAYMENT","INTERNAL_COUNTERPARTY","OTHER"],"nullable":true},"exemptionReason":{"type":"string","description":"Reason for the applied exemption.","nullable":true}}},"PartnerPaymentResponse":{"type":"object","properties":{"paymentId":{"type":"string","format":"uuid","description":"Unique identifier of the payment"},"processingState":{"type":"string","enum":["CREATED","PROCESSING","SUCCESS","FAILURE"],"description":"Processing state of the payment"},"failureReason":{"type":"string","enum":["ALREADY_PROCESS","AML_BLOCKED_INBOUND_TRANSFER","AML_BLOCKED_OUTBOUND_TRANSFER","EXCEEDS_LIMIT","INSUFFICIENT_BALANCE","INVALID_COUNTERPARTY","RAIL_NOT_SUPPORTED","RESTRICTED_INBOUND_TRANSFER","RESTRICTED_OUTBOUND_TRANSFER","TECHNICAL_ERROR","INSUFFICIENT_FUNDS","PAYMENT_NOT_RETURNABLE","UNDEFINED"],"description":"Details of the payment failure","nullable":true},"createdOn":{"format":"date-time","type":"string","description":"Timestamp when the payment was created"},"transaction":{"nullable":true,"description":"Transaction associated with the payment, if available","allOf":[{"$ref":"#/components/schemas/PartnerTransactionResponse"}]},"initiationRequest":{"description":"Original request payload that initiated the payment","oneOf":[{"$ref":"#/components/schemas/PartnerPaymentInternalPayload"},{"$ref":"#/components/schemas/PartnerPaymentExternalPayload"},{"$ref":"#/components/schemas/PartnerPaymentFundingInitiatePayload"},{"$ref":"#/components/schemas/PartnerCardFundingInitiatePayload"}]}},"required":["paymentId","processingState","createdOn","initiationRequest"]},"PartnerTransactionResponse":{"type":"object","properties":{"transactionId":{"type":"string","description":"Unique identifier of the transaction"},"uniqueToken":{"type":"string","format":"uuid","description":"Unique token of the transaction"},"origin":{"type":"string","description":"Origin of the transaction","enum":["TRANSFER","CARD"]},"state":{"type":"string","description":"Current state of the transaction","enum":["PENDING","COMPLETED","CANCELLED","FAILED"]},"category":{"type":"string","description":"Category of the transaction","enum":["GENERAL","SHOPPING","TRANSFERS","EATING_OUT","DONATIONS","FAMILY","CASH","ENTERTAINMENT","EXPENSES","GIFTS","GROCERIES","HOLIDAYS","INVESTMENTS","PERSONAL_CARE","SALARY","SAVINGS","SERVICES","TRANSPORT","UTILITIES","CASHBACK_REWARDS","REFERRAL_REWARDS"]},"impactType":{"type":"string","description":"Indicates if the transaction is a debit or credit","enum":["NEUTRAL","DEBIT","CREDIT"]},"customerId":{"type":"string","description":"Customer identifier associated with this transaction","format":"uuid","nullable":true},"programId":{"type":"string","description":"Program account identifier associated with this transaction","format":"uuid","nullable":true},"amount":{"type":"number","description":"Transaction amount in minor units (e.g. 129 for £1.29)"},"currencyCode":{"type":"string","enum":["AFN","EUR","ALL","DZD","USD","AOA","XCD","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","INR","BTN","BOB","BOV","BAM","BWP","NOK","BRL","BND","BGN","BIF","CVE","KHR","XAF","CAD","KYD","CLP","CLF","CNY","COP","COU","KMF","CDF","NZD","CRC","HRK","CUP","CUC","ANG","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FKP","FJD","XPF","GMD","GEL","GHS","GIP","GTQ","GBP","GNF","GYD","HTG","HNL","HKD","HUF","ISK","IDR","XDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","ZAR","LRD","LYD","CHF","MOP","MKD","MGA","MWK","MYR","MVR","MRU","MUR","XUA","MXN","MXV","MDL","MNT","MAD","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","STN","SAR","RSD","SCR","SLL","SGD","XSU","SBD","SOS","SSP","LKR","SDG","SRD","SEK","CHE","CHW","SYP","TWD","TJS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","USN","UYU","UYI","UYW","UZS","VUV","VES","VND","YER","ZMW","ZWL","XBA","XBB","XBC","XBD","XTS","XXX","XAU","XPD","XPT","XAG","AFA","FIM","ADP","ESP","FRF","AOK","AOR","RUR","ATS","AYM","AZM","BYB","BYR","BEC","BEF","BEL","BAD","BRB","BRR","BGJ","CYP","CSK","ECS","ECV","GQE","EEK","XEU","GEK","DDM","DEM","GHC","GHP","GRD","GWE","ITL","IEP","LVL","ZAL","LTL","LUC","LUF","LUL","MGF","MLF","MTL","MRO","MZE","NLG","PLZ","PTE","ROK","STD","CSD","SKK","SIT","RHD","ESA","ESB","SDD","SRG","TJR","TPE","TRL","TMM","UAK","USS","VEB","VEF","YUD","ZRN","ZMK","ZWN","ZWR"],"description":"Currency of the transaction amount"},"description":{"type":"string","description":"Description of the transaction"},"exchangeRate":{"type":"string","description":"Exchange rate applied to this transaction"},"exchangeCurrencyCode":{"type":"string","description":"Currency used for exchange in this transaction","enum":["AFN","EUR","ALL","DZD","USD","AOA","XCD","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","INR","BTN","BOB","BOV","BAM","BWP","NOK","BRL","BND","BGN","BIF","CVE","KHR","XAF","CAD","KYD","CLP","CLF","CNY","COP","COU","KMF","CDF","NZD","CRC","HRK","CUP","CUC","ANG","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FKP","FJD","XPF","GMD","GEL","GHS","GIP","GTQ","GBP","GNF","GYD","HTG","HNL","HKD","HUF","ISK","IDR","XDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","ZAR","LRD","LYD","CHF","MOP","MKD","MGA","MWK","MYR","MVR","MRU","MUR","XUA","MXN","MXV","MDL","MNT","MAD","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","STN","SAR","RSD","SCR","SLL","SGD","XSU","SBD","SOS","SSP","LKR","SDG","SRD","SEK","CHE","CHW","SYP","TWD","TJS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","USN","UYU","UYI","UYW","UZS","VUV","VES","VND","YER","ZMW","ZWL","XBA","XBB","XBC","XBD","XTS","XXX","XAU","XPD","XPT","XAG","AFA","FIM","ADP","ESP","FRF","AOK","AOR","RUR","ATS","AYM","AZM","BYB","BYR","BEC","BEF","BEL","BAD","BRB","BRR","BGJ","CYP","CSK","ECS","ECV","GQE","EEK","XEU","GEK","DDM","DEM","GHC","GHP","GRD","GWE","ITL","IEP","LVL","ZAL","LTL","LUC","LUF","LUL","MGF","MLF","MTL","MRO","MZE","NLG","PLZ","PTE","ROK","STD","CSD","SKK","SIT","RHD","ESA","ESB","SDD","SRG","TJR","TPE","TRL","TMM","UAK","USS","VEB","VEF","YUD","ZRN","ZMK","ZWN","ZWR"]},"sourceCounterparty":{"oneOf":[{"$ref":"#/components/schemas/PartnerPaymentReferenceCounterpartyPayload"},{"$ref":"#/components/schemas/PartnerPaymentAccountIdCounterpartyPayload"}],"description":"Details of the counterparty sending the payment, if applicable"},"destinationCounterparty":{"oneOf":[{"$ref":"#/components/schemas/PartnerPaymentReferenceCounterpartyPayload"},{"$ref":"#/components/schemas/PartnerPaymentAccountIdCounterpartyPayload"}],"description":"Details of the counterparty receiving the payment, if applicable"},"transactionDate":{"format":"date-time","type":"string","description":"Timestamp when the transaction took place"},"cardMetadata":{"nullable":true,"description":"Additional metadata about the card process","allOf":[{"$ref":"#/components/schemas/PartnerTransactionCardMetadataPayload"}]},"transferMetadata":{"nullable":true,"description":"Additional metadata about the transfer process","allOf":[{"$ref":"#/components/schemas/PartnerTransactionTransferMetadataPayload"}]}},"required":["transactionId","uniqueToken","origin","state","category","impactType","customerId","programId","amount","currencyCode","description","exchangeRate","exchangeCurrencyCode","sourceCounterparty","destinationCounterparty","transactionDate"]},"PartnerPaymentReferenceCounterpartyPayload":{"type":"object","properties":{"type":{"type":"string","description":"Type of counterparty","enum":["BUSINESS","PERSONAL","UNKNOWN"]},"details":{"description":"Counterparty details varies on type","oneOf":[{"$ref":"#/components/schemas/PartnerPersonalDetailsPayload"},{"$ref":"#/components/schemas/PartnerBusinessDetailsPayload"},{"$ref":"#/components/schemas/PartnerUnknownDetailsPayload"}]},"accountCurrency":{"type":"string","description":"Currency of the counterparty account.","enum":["AFN","EUR","ALL","DZD","USD","AOA","XCD","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","INR","BTN","BOB","BOV","BAM","BWP","NOK","BRL","BND","BGN","BIF","CVE","KHR","XAF","CAD","KYD","CLP","CLF","CNY","COP","COU","KMF","CDF","NZD","CRC","HRK","CUP","CUC","ANG","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FKP","FJD","XPF","GMD","GEL","GHS","GIP","GTQ","GBP","GNF","GYD","HTG","HNL","HKD","HUF","ISK","IDR","XDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","ZAR","LRD","LYD","CHF","MOP","MKD","MGA","MWK","MYR","MVR","MRU","MUR","XUA","MXN","MXV","MDL","MNT","MAD","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","STN","SAR","RSD","SCR","SLL","SGD","XSU","SBD","SOS","SSP","LKR","SDG","SRD","SEK","CHE","CHW","SYP","TWD","TJS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","USN","UYU","UYI","UYW","UZS","VUV","VES","VND","YER","ZMW","ZWL","XBA","XBB","XBC","XBD","XTS","XXX","XAU","XPD","XPT","XAG","AFA","FIM","ADP","ESP","FRF","AOK","AOR","RUR","ATS","AYM","AZM","BYB","BYR","BEC","BEF","BEL","BAD","BRB","BRR","BGJ","CYP","CSK","ECS","ECV","GQE","EEK","XEU","GEK","DDM","DEM","GHC","GHP","GRD","GWE","ITL","IEP","LVL","ZAL","LTL","LUC","LUF","LUL","MGF","MLF","MTL","MRO","MZE","NLG","PLZ","PTE","ROK","STD","CSD","SKK","SIT","RHD","ESA","ESB","SDD","SRG","TJR","TPE","TRL","TMM","UAK","USS","VEB","VEF","YUD","ZRN","ZMK","ZWN","ZWR"]},"accountReferenceType":{"type":"string","description":"Type of account reference used for the counterparty.","enum":["UK_ACCOUNT","IBAN","CUSTODY_ID","OTHER_EXTERNAL","GENERIC_ACCOUNT"]},"accountReference":{"description":"Details of the account reference. Format varies depending on reference type.","oneOf":[{"$ref":"#/components/schemas/PartnerPaymentDomesticCounterpartyPayload"},{"$ref":"#/components/schemas/PartnerPaymentIBANCounterpartyPayload"},{"$ref":"#/components/schemas/PartnerPaymentCustodyIdCounterpartyPayload"},{"$ref":"#/components/schemas/PartnerPaymentOtherExternalCounterpartyPayload"},{"$ref":"#/components/schemas/PartnerPaymentGenericAccountCounterpartyPayload"}]},"address":{"description":"Counterparty address (required when accountReferenceType is IBAN or GENERIC_ACCOUNT)","nullable":true,"allOf":[{"$ref":"#/components/schemas/PartnerPaymentAddressPayload"}]}},"required":["type","details","accountCurrency","accountReferenceType","accountReference"]},"PartnerPersonalDetailsPayload":{"type":"object","properties":{"firstName":{"type":"string","description":"First name of the counterparty.","maxLength":70},"lastName":{"type":"string","description":"Last name of the counterparty.","maxLength":70}},"required":["firstName","lastName"]},"PartnerBusinessDetailsPayload":{"type":"object","properties":{"businessName":{"type":"string","description":"Registered legal name of the business partner","maxLength":140}},"required":["businessName"]},"PartnerUnknownDetailsPayload":{"type":"object","properties":{"name":{"type":"string","description":"Name of the counterparty","maxLength":140}},"required":["name"]},"PartnerPaymentDomesticCounterpartyPayload":{"type":"object","properties":{"sortCode":{"type":"string","description":"UK domestic bank sort code."},"accountNumber":{"type":"string","description":"UK domestic bank account number."}},"required":["sortCode","accountNumber"]},"PartnerPaymentIBANCounterpartyPayload":{"type":"object","properties":{"iban":{"type":"string","description":"International Bank Account Number (IBAN)."},"bic":{"type":"string","description":"Bank Identifier Code (BIC)."},"currency":{"type":"string","description":"Currency of the counterparty account.","enum":["AFN","EUR","ALL","DZD","USD","AOA","XCD","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","INR","BTN","BOB","BOV","BAM","BWP","NOK","BRL","BND","BGN","BIF","CVE","KHR","XAF","CAD","KYD","CLP","CLF","CNY","COP","COU","KMF","CDF","NZD","CRC","HRK","CUP","CUC","ANG","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FKP","FJD","XPF","GMD","GEL","GHS","GIP","GTQ","GBP","GNF","GYD","HTG","HNL","HKD","HUF","ISK","IDR","XDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","ZAR","LRD","LYD","CHF","MOP","MKD","MGA","MWK","MYR","MVR","MRU","MUR","XUA","MXN","MXV","MDL","MNT","MAD","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","STN","SAR","RSD","SCR","SLL","SGD","XSU","SBD","SOS","SSP","LKR","SDG","SRD","SEK","CHE","CHW","SYP","TWD","TJS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","USN","UYU","UYI","UYW","UZS","VUV","VES","VND","YER","ZMW","ZWL","XBA","XBB","XBC","XBD","XTS","XXX","XAU","XPD","XPT","XAG","AFA","FIM","ADP","ESP","FRF","AOK","AOR","RUR","ATS","AYM","AZM","BYB","BYR","BEC","BEF","BEL","BAD","BRB","BRR","BGJ","CYP","CSK","ECS","ECV","GQE","EEK","XEU","GEK","DDM","DEM","GHC","GHP","GRD","GWE","ITL","IEP","LVL","ZAL","LTL","LUC","LUF","LUL","MGF","MLF","MTL","MRO","MZE","NLG","PLZ","PTE","ROK","STD","CSD","SKK","SIT","RHD","ESA","ESB","SDD","SRG","TJR","TPE","TRL","TMM","UAK","USS","VEB","VEF","YUD","ZRN","ZMK","ZWN","ZWR"]},"country":{"type":"string","description":"Country of the counterparty account.","enum":["AFG","ALA","ALB","DZA","ASM","AND","AGO","AIA","ATA","ATG","ARG","ARM","ABW","AUS","AUT","AZE","BHS","BHR","BGD","BRB","BLR","BEL","BLZ","BEN","BMU","BTN","BOL","BES","BIH","BWA","BVT","BRA","IOT","BRN","BGR","BFA","BDI","CPV","KHM","CMR","CAN","CYM","CAF","TCD","CHL","CHN","CXR","CCK","COL","COM","COG","COD","COK","CRI","CIV","HRV","CUB","CUW","CYP","CZE","DNK","DJI","DMA","DOM","ECU","EGY","SLV","GNQ","ERI","EST","SWZ","ETH","FLK","FRO","FJI","FIN","FRA","GUF","PYF","ATF","GAB","GMB","GEO","DEU","GHA","GIB","GRC","GRL","GRD","GLP","GUM","GTM","GGY","GIN","GNB","GUY","HTI","HMD","VAT","HND","HKG","HUN","ISL","IND","IDN","IRN","IRQ","IRL","IMN","ISR","ITA","JAM","JPN","JEY","JOR","KAZ","KEN","KIR","PRK","KOR","KWT","KGZ","LAO","LVA","LBN","LSO","LBR","LBY","LIE","LTU","LUX","MAC","MDG","MWI","MYS","MDV","MLI","MLT","MHL","MTQ","MRT","MUS","MYT","MEX","FSM","MDA","MCO","MNG","MNE","MSR","MAR","MOZ","MMR","NAM","NRU","NPL","NLD","NCL","NZL","NIC","NER","NGA","NIU","NFK","MKD","MNP","NOR","OMN","PAK","PLW","PSE","PAN","PNG","PRY","PER","PHL","PCN","POL","PRT","PRI","QAT","REU","ROU","RUS","RWA","BLM","SHN","KNA","LCA","MAF","SPM","VCT","WSM","SMR","STP","SAU","SEN","SRB","SYC","SLE","SGP","SXM","SVK","SVN","SLB","SOM","ZAF","SGS","SSD","ESP","LKA","SDN","SUR","SJM","SWE","CHE","SYR","TWN","TJK","TZA","THA","TLS","TGO","TKL","TON","TTO","TUN","TUR","TKM","TCA","TUV","UGA","UKR","ARE","GBR","USA","UMI","URY","UZB","VUT","VEN","VNM","VGB","VIR","WLF","ESH","YEM","ZMB","ZWE","XXK","XKX"]}},"required":["iban","bic","currency","country"]},"PartnerPaymentCustodyIdCounterpartyPayload":{"type":"object","properties":{"id":{"type":"string","description":"External identifier"}},"required":["id"]},"PartnerPaymentOtherExternalCounterpartyPayload":{"type":"object","properties":{"descriptor":{"type":"string","description":"Descriptor of the account."},"bic":{"type":"string","description":"Bank Identifier Code (BIC).","nullable":true},"currency":{"type":"string","description":"Currency of the counterparty account.","enum":["AFN","EUR","ALL","DZD","USD","AOA","XCD","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","INR","BTN","BOB","BOV","BAM","BWP","NOK","BRL","BND","BGN","BIF","CVE","KHR","XAF","CAD","KYD","CLP","CLF","CNY","COP","COU","KMF","CDF","NZD","CRC","HRK","CUP","CUC","ANG","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FKP","FJD","XPF","GMD","GEL","GHS","GIP","GTQ","GBP","GNF","GYD","HTG","HNL","HKD","HUF","ISK","IDR","XDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","ZAR","LRD","LYD","CHF","MOP","MKD","MGA","MWK","MYR","MVR","MRU","MUR","XUA","MXN","MXV","MDL","MNT","MAD","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","STN","SAR","RSD","SCR","SLL","SGD","XSU","SBD","SOS","SSP","LKR","SDG","SRD","SEK","CHE","CHW","SYP","TWD","TJS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","USN","UYU","UYI","UYW","UZS","VUV","VES","VND","YER","ZMW","ZWL","XBA","XBB","XBC","XBD","XTS","XXX","XAU","XPD","XPT","XAG","AFA","FIM","ADP","ESP","FRF","AOK","AOR","RUR","ATS","AYM","AZM","BYB","BYR","BEC","BEF","BEL","BAD","BRB","BRR","BGJ","CYP","CSK","ECS","ECV","GQE","EEK","XEU","GEK","DDM","DEM","GHC","GHP","GRD","GWE","ITL","IEP","LVL","ZAL","LTL","LUC","LUF","LUL","MGF","MLF","MTL","MRO","MZE","NLG","PLZ","PTE","ROK","STD","CSD","SKK","SIT","RHD","ESA","ESB","SDD","SRG","TJR","TPE","TRL","TMM","UAK","USS","VEB","VEF","YUD","ZRN","ZMK","ZWN","ZWR"]},"country":{"type":"string","description":"Country of the counterparty account.","enum":["AFG","ALA","ALB","DZA","ASM","AND","AGO","AIA","ATA","ATG","ARG","ARM","ABW","AUS","AUT","AZE","BHS","BHR","BGD","BRB","BLR","BEL","BLZ","BEN","BMU","BTN","BOL","BES","BIH","BWA","BVT","BRA","IOT","BRN","BGR","BFA","BDI","CPV","KHM","CMR","CAN","CYM","CAF","TCD","CHL","CHN","CXR","CCK","COL","COM","COG","COD","COK","CRI","CIV","HRV","CUB","CUW","CYP","CZE","DNK","DJI","DMA","DOM","ECU","EGY","SLV","GNQ","ERI","EST","SWZ","ETH","FLK","FRO","FJI","FIN","FRA","GUF","PYF","ATF","GAB","GMB","GEO","DEU","GHA","GIB","GRC","GRL","GRD","GLP","GUM","GTM","GGY","GIN","GNB","GUY","HTI","HMD","VAT","HND","HKG","HUN","ISL","IND","IDN","IRN","IRQ","IRL","IMN","ISR","ITA","JAM","JPN","JEY","JOR","KAZ","KEN","KIR","PRK","KOR","KWT","KGZ","LAO","LVA","LBN","LSO","LBR","LBY","LIE","LTU","LUX","MAC","MDG","MWI","MYS","MDV","MLI","MLT","MHL","MTQ","MRT","MUS","MYT","MEX","FSM","MDA","MCO","MNG","MNE","MSR","MAR","MOZ","MMR","NAM","NRU","NPL","NLD","NCL","NZL","NIC","NER","NGA","NIU","NFK","MKD","MNP","NOR","OMN","PAK","PLW","PSE","PAN","PNG","PRY","PER","PHL","PCN","POL","PRT","PRI","QAT","REU","ROU","RUS","RWA","BLM","SHN","KNA","LCA","MAF","SPM","VCT","WSM","SMR","STP","SAU","SEN","SRB","SYC","SLE","SGP","SXM","SVK","SVN","SLB","SOM","ZAF","SGS","SSD","ESP","LKA","SDN","SUR","SJM","SWE","CHE","SYR","TWN","TJK","TZA","THA","TLS","TGO","TKL","TON","TTO","TUN","TUR","TKM","TCA","TUV","UGA","UKR","ARE","GBR","USA","UMI","URY","UZB","VUT","VEN","VNM","VGB","VIR","WLF","ESH","YEM","ZMB","ZWE","XXK","XKX"],"nullable":true}},"required":["descriptor","currency"]},"PartnerPaymentGenericAccountCounterpartyPayload":{"type":"object","properties":{"accountNumber":{"type":"string","description":"Account number (required unless routingType is CLABE)","nullable":true},"routingType":{"type":"string","description":"Primary routing type (required when BIC is not provided)","enum":["ROUTING_CODE","GIRO_ROUTING_CODE","ACH_ROUTING_NUMBER","FAST_ROUTING_CODE","WIRE_ROUTING_NUMBER","MEPS_ROUTING_CODE","ABA_ROUTING_NUMBER","BANK_CODE","BRANCH_CODE","BSB_CODE","CLABE","CNAPS","IFSC","INSTITUTION_NO"],"nullable":true},"routingNumber":{"type":"string","description":"Primary routing number (required when routingType is provided)","nullable":true},"secondaryRoutingType":{"type":"string","description":"Secondary routing type","enum":["ROUTING_CODE","GIRO_ROUTING_CODE","ACH_ROUTING_NUMBER","FAST_ROUTING_CODE","WIRE_ROUTING_NUMBER","MEPS_ROUTING_CODE","ABA_ROUTING_NUMBER","BANK_CODE","BRANCH_CODE","BSB_CODE","CLABE","CNAPS","IFSC","INSTITUTION_NO"],"nullable":true},"secondaryRoutingNumber":{"type":"string","description":"Secondary routing number (required when secondaryRoutingType is provided)","nullable":true},"bic":{"type":"string","description":"Bank Identifier Code (required when routingType is not provided)","nullable":true},"currency":{"type":"string","description":"Currency of the counterparty account.","enum":["AFN","EUR","ALL","DZD","USD","AOA","XCD","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","INR","BTN","BOB","BOV","BAM","BWP","NOK","BRL","BND","BGN","BIF","CVE","KHR","XAF","CAD","KYD","CLP","CLF","CNY","COP","COU","KMF","CDF","NZD","CRC","HRK","CUP","CUC","ANG","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FKP","FJD","XPF","GMD","GEL","GHS","GIP","GTQ","GBP","GNF","GYD","HTG","HNL","HKD","HUF","ISK","IDR","XDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","ZAR","LRD","LYD","CHF","MOP","MKD","MGA","MWK","MYR","MVR","MRU","MUR","XUA","MXN","MXV","MDL","MNT","MAD","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","STN","SAR","RSD","SCR","SLL","SGD","XSU","SBD","SOS","SSP","LKR","SDG","SRD","SEK","CHE","CHW","SYP","TWD","TJS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","USN","UYU","UYI","UYW","UZS","VUV","VES","VND","YER","ZMW","ZWL","XBA","XBB","XBC","XBD","XTS","XXX","XAU","XPD","XPT","XAG","AFA","FIM","ADP","ESP","FRF","AOK","AOR","RUR","ATS","AYM","AZM","BYB","BYR","BEC","BEF","BEL","BAD","BRB","BRR","BGJ","CYP","CSK","ECS","ECV","GQE","EEK","XEU","GEK","DDM","DEM","GHC","GHP","GRD","GWE","ITL","IEP","LVL","ZAL","LTL","LUC","LUF","LUL","MGF","MLF","MTL","MRO","MZE","NLG","PLZ","PTE","ROK","STD","CSD","SKK","SIT","RHD","ESA","ESB","SDD","SRG","TJR","TPE","TRL","TMM","UAK","USS","VEB","VEF","YUD","ZRN","ZMK","ZWN","ZWR"]},"country":{"type":"string","description":"Country of the counterparty account.","enum":["AFG","ALA","ALB","DZA","ASM","AND","AGO","AIA","ATA","ATG","ARG","ARM","ABW","AUS","AUT","AZE","BHS","BHR","BGD","BRB","BLR","BEL","BLZ","BEN","BMU","BTN","BOL","BES","BIH","BWA","BVT","BRA","IOT","BRN","BGR","BFA","BDI","CPV","KHM","CMR","CAN","CYM","CAF","TCD","CHL","CHN","CXR","CCK","COL","COM","COG","COD","COK","CRI","CIV","HRV","CUB","CUW","CYP","CZE","DNK","DJI","DMA","DOM","ECU","EGY","SLV","GNQ","ERI","EST","SWZ","ETH","FLK","FRO","FJI","FIN","FRA","GUF","PYF","ATF","GAB","GMB","GEO","DEU","GHA","GIB","GRC","GRL","GRD","GLP","GUM","GTM","GGY","GIN","GNB","GUY","HTI","HMD","VAT","HND","HKG","HUN","ISL","IND","IDN","IRN","IRQ","IRL","IMN","ISR","ITA","JAM","JPN","JEY","JOR","KAZ","KEN","KIR","PRK","KOR","KWT","KGZ","LAO","LVA","LBN","LSO","LBR","LBY","LIE","LTU","LUX","MAC","MDG","MWI","MYS","MDV","MLI","MLT","MHL","MTQ","MRT","MUS","MYT","MEX","FSM","MDA","MCO","MNG","MNE","MSR","MAR","MOZ","MMR","NAM","NRU","NPL","NLD","NCL","NZL","NIC","NER","NGA","NIU","NFK","MKD","MNP","NOR","OMN","PAK","PLW","PSE","PAN","PNG","PRY","PER","PHL","PCN","POL","PRT","PRI","QAT","REU","ROU","RUS","RWA","BLM","SHN","KNA","LCA","MAF","SPM","VCT","WSM","SMR","STP","SAU","SEN","SRB","SYC","SLE","SGP","SXM","SVK","SVN","SLB","SOM","ZAF","SGS","SSD","ESP","LKA","SDN","SUR","SJM","SWE","CHE","SYR","TWN","TJK","TZA","THA","TLS","TGO","TKL","TON","TTO","TUN","TUR","TKM","TCA","TUV","UGA","UKR","ARE","GBR","USA","UMI","URY","UZB","VUT","VEN","VNM","VGB","VIR","WLF","ESH","YEM","ZMB","ZWE","XXK","XKX"]}},"required":["currency","country"]},"PartnerPaymentAddressPayload":{"type":"object","properties":{"buildingName":{"type":"string","description":"Building name","nullable":true},"buildingNumber":{"type":"string","description":"Building number","nullable":true},"state":{"type":"string","description":"State / region","nullable":true},"street":{"type":"string","description":"Street / address line"},"town":{"type":"string","description":"Town / city"},"postcode":{"type":"string","description":"Postal / ZIP code"},"country":{"type":"string","description":"Country code","enum":["AFG","ALA","ALB","DZA","ASM","AND","AGO","AIA","ATA","ATG","ARG","ARM","ABW","AUS","AUT","AZE","BHS","BHR","BGD","BRB","BLR","BEL","BLZ","BEN","BMU","BTN","BOL","BES","BIH","BWA","BVT","BRA","IOT","BRN","BGR","BFA","BDI","CPV","KHM","CMR","CAN","CYM","CAF","TCD","CHL","CHN","CXR","CCK","COL","COM","COG","COD","COK","CRI","CIV","HRV","CUB","CUW","CYP","CZE","DNK","DJI","DMA","DOM","ECU","EGY","SLV","GNQ","ERI","EST","SWZ","ETH","FLK","FRO","FJI","FIN","FRA","GUF","PYF","ATF","GAB","GMB","GEO","DEU","GHA","GIB","GRC","GRL","GRD","GLP","GUM","GTM","GGY","GIN","GNB","GUY","HTI","HMD","VAT","HND","HKG","HUN","ISL","IND","IDN","IRN","IRQ","IRL","IMN","ISR","ITA","JAM","JPN","JEY","JOR","KAZ","KEN","KIR","PRK","KOR","KWT","KGZ","LAO","LVA","LBN","LSO","LBR","LBY","LIE","LTU","LUX","MAC","MDG","MWI","MYS","MDV","MLI","MLT","MHL","MTQ","MRT","MUS","MYT","MEX","FSM","MDA","MCO","MNG","MNE","MSR","MAR","MOZ","MMR","NAM","NRU","NPL","NLD","NCL","NZL","NIC","NER","NGA","NIU","NFK","MKD","MNP","NOR","OMN","PAK","PLW","PSE","PAN","PNG","PRY","PER","PHL","PCN","POL","PRT","PRI","QAT","REU","ROU","RUS","RWA","BLM","SHN","KNA","LCA","MAF","SPM","VCT","WSM","SMR","STP","SAU","SEN","SRB","SYC","SLE","SGP","SXM","SVK","SVN","SLB","SOM","ZAF","SGS","SSD","ESP","LKA","SDN","SUR","SJM","SWE","CHE","SYR","TWN","TJK","TZA","THA","TLS","TGO","TKL","TON","TTO","TUN","TUR","TKM","TCA","TUV","UGA","UKR","ARE","GBR","USA","UMI","URY","UZB","VUT","VEN","VNM","VGB","VIR","WLF","ESH","YEM","ZMB","ZWE","XXK","XKX"]}},"required":["street","town","postcode","country"]},"PartnerPaymentAccountIdCounterpartyPayload":{"type":"object","properties":{"type":{"type":"string","description":"Type of counterparty","enum":["BUSINESS","PERSONAL","UNKNOWN"]},"accountCurrency":{"type":"string","description":"Currency of the counterparty account.","enum":["AFN","EUR","ALL","DZD","USD","AOA","XCD","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","INR","BTN","BOB","BOV","BAM","BWP","NOK","BRL","BND","BGN","BIF","CVE","KHR","XAF","CAD","KYD","CLP","CLF","CNY","COP","COU","KMF","CDF","NZD","CRC","HRK","CUP","CUC","ANG","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FKP","FJD","XPF","GMD","GEL","GHS","GIP","GTQ","GBP","GNF","GYD","HTG","HNL","HKD","HUF","ISK","IDR","XDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","ZAR","LRD","LYD","CHF","MOP","MKD","MGA","MWK","MYR","MVR","MRU","MUR","XUA","MXN","MXV","MDL","MNT","MAD","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","STN","SAR","RSD","SCR","SLL","SGD","XSU","SBD","SOS","SSP","LKR","SDG","SRD","SEK","CHE","CHW","SYP","TWD","TJS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","USN","UYU","UYI","UYW","UZS","VUV","VES","VND","YER","ZMW","ZWL","XBA","XBB","XBC","XBD","XTS","XXX","XAU","XPD","XPT","XAG","AFA","FIM","ADP","ESP","FRF","AOK","AOR","RUR","ATS","AYM","AZM","BYB","BYR","BEC","BEF","BEL","BAD","BRB","BRR","BGJ","CYP","CSK","ECS","ECV","GQE","EEK","XEU","GEK","DDM","DEM","GHC","GHP","GRD","GWE","ITL","IEP","LVL","ZAL","LTL","LUC","LUF","LUL","MGF","MLF","MTL","MRO","MZE","NLG","PLZ","PTE","ROK","STD","CSD","SKK","SIT","RHD","ESA","ESB","SDD","SRG","TJR","TPE","TRL","TMM","UAK","USS","VEB","VEF","YUD","ZRN","ZMK","ZWN","ZWR"]},"accountId":{"type":"string","description":"Id of the account"},"address":{"description":"Counterparty address","nullable":true,"allOf":[{"$ref":"#/components/schemas/PartnerPaymentAddressPayload"}]}},"required":["type","accountCurrency","accountId"]},"PartnerTransactionCardMetadataPayload":{"type":"object","properties":{"phase":{"type":"string","description":"Phase of the card transaction.","enum":["AUTHORIZATION","INCREMENTAL","ADVICE","REVERSAL","EXPIRATION_REVERSAL","CLEARING","FORCE_CLEARING"]},"type":{"type":"string","description":"Type of the card transaction. Optional but recommended for accurate reference generation.","enum":["ACTIVE_CARD_CHECK","CARD_PAYMENT","REFUND","ATM_WITHDRAWAL","ORIGINAL_CREDIT","CASHBACK","QUASI_CASH"]},"cardToken":{"type":"string","description":"Unique reference for the card.","format":"uuid"},"transactionToken":{"type":"string","description":"Unique reference for the card transaction, to logically group multiple events.","format":"uuid"},"eventToken":{"type":"string","description":"Unique reference for the card event.","format":"uuid"},"lastDigits":{"type":"string","description":"Last 4 digits of the card.","pattern":"^[0-9]{4}$"},"scheme":{"description":"Card transaction scheme information (network, bin prefix, etc.).","allOf":[{"$ref":"#/components/schemas/PartnerCardTransactionScheme"}]},"cardAcceptor":{"description":"Card acceptor information (merchant details).","allOf":[{"$ref":"#/components/schemas/PartnerCardTransactionAcceptor"}]},"pos":{"description":"Point of sale information.","allOf":[{"$ref":"#/components/schemas/PartnerCardTransactionPos"}]},"merchant":{"description":"Merchant information.","allOf":[{"$ref":"#/components/schemas/PartnerTransactionMerchantPayload"}]}},"required":["phase","transactionToken","eventToken","lastDigits"]},"PartnerCardTransactionScheme":{"type":"object","properties":{"network":{"type":"string","description":"Network name (e.g., MasterCard, Visa)"},"binPrefix":{"type":"string","description":"Bank Identification Number prefix"},"referenceId":{"type":"string","description":"Reference identifier for the scheme"}}},"PartnerCardTransactionAcceptor":{"type":"object","properties":{"networkMid":{"type":"string","description":"Network merchant identifier"},"mccGroups":{"description":"Merchant category code groups","type":"array","items":{"type":"string"}},"mid":{"type":"string","description":"Merchant identifier"},"mcc":{"type":"string","description":"Merchant category code"},"name":{"type":"string","description":"Merchant name"},"address":{"type":"string","description":"Merchant address"},"city":{"type":"string","description":"Merchant city"},"state":{"type":"string","description":"Merchant state or province"},"postcode":{"type":"string","description":"Merchant postal code"},"country":{"type":"string","description":"Merchant country code (ISO 3166-1 alpha-2)"}}},"PartnerCardTransactionPos":{"type":"object","properties":{"panEntryMode":{"type":"string","description":"Primary Account Number entry mode"},"pinEntryMode":{"type":"string","description":"PIN entry mode"},"cardPresent":{"type":"boolean","description":"Indicates if the card was physically present"},"pinPresent":{"type":"boolean","description":"Indicates if PIN was entered"},"partialApprovalCapable":{"type":"boolean","description":"Indicates if partial approval is capable"},"purchaseAmountOnly":{"type":"boolean","description":"Indicates if this is purchase amount only"},"isRecurring":{"type":"boolean","description":"Indicates if this is a recurring transaction"},"isInstallment":{"type":"boolean","description":"Indicates if this is an installment transaction"},"cardHolderPresent":{"type":"boolean","description":"Indicates if cardholder was present"},"countryCode":{"type":"string","description":"Country code (ISO 3166-1 alpha-2)"},"postCode":{"type":"string","description":"Postal code"},"terminalAttendence":{"type":"string","description":"Terminal attendance indicator"},"terminalId":{"type":"string","description":"Terminal identifier"},"terminalLocation":{"type":"string","description":"Terminal location"}}},"PartnerTransactionMerchantPayload":{"type":"object","properties":{"id":{"type":"string","description":"Merchant id"},"name":{"type":"string","description":"Merchant name"},"summary":{"type":"string","description":"Merchant summary","nullable":true},"imageUrl":{"type":"string","description":"Merchant image url","nullable":true},"webAddressUrl":{"type":"string","description":"Merchant web address url","nullable":true},"address":{"description":"Merchant address","nullable":true,"allOf":[{"$ref":"#/components/schemas/PartnerTransactionMerchantAddressPayload"}]},"location":{"description":"Merchant location","nullable":true,"allOf":[{"$ref":"#/components/schemas/PartnerTransactionMerchantLocationPayload"}]}},"required":["id","name"]},"PartnerTransactionMerchantAddressPayload":{"type":"object","properties":{"flatNumber":{"type":"string","description":"Flat Number","nullable":true},"buildingNumber":{"type":"string","description":"Building Number","nullable":true},"buildingName":{"type":"string","description":"Building Name","nullable":true},"street":{"type":"string","description":"Street","nullable":true},"subStreet":{"type":"string","description":"Sub Street","nullable":true},"town":{"type":"string","description":"Town","nullable":true},"state":{"type":"string","description":"State","nullable":true},"line1":{"type":"string","description":"Address Line 1","nullable":true},"line2":{"type":"string","description":"Address Line 2","nullable":true},"line3":{"type":"string","description":"Address Line 3","nullable":true},"postcode":{"type":"string","description":"Postcode"},"country":{"type":"string","description":"Country"}},"required":["postcode","country"]},"PartnerTransactionMerchantLocationPayload":{"type":"object","properties":{"latitude":{"type":"string","description":"Latitude"},"longitude":{"type":"string","description":"Longitude"}},"required":["latitude","longitude"]},"PartnerTransactionTransferMetadataPayload":{"type":"object","properties":{"rails":{"type":"string","description":"Outbound rails used for the transfer, if applicable","enum":["FASTER_PAYMENTS","CHAPS","BACS","INTERNAL","INTERNATIONAL"],"nullable":true},"transactionProgress":{"nullable":true,"description":"Timeline of progress events for this transfer","type":"array","items":{"$ref":"#/components/schemas/PartnerTransactionProgressPayload"}},"fundingSourceProvider":{"nullable":true,"description":"Funding source provider","allOf":[{"$ref":"#/components/schemas/PartnerPaymentFundingSourceResponse"}]},"transferType":{"type":"string","enum":["OUTBOUND_CONTACT","INBOUND_PISP","INBOUND_LINK","INBOUND_RAILS","OUTBOUND_LINK","SPLIT_REQUEST","CUBE_TRANSFER","OUTBOUND_NOMINATED","RETURN"]},"returnReason":{"type":"string","enum":["ACCOUNT_SUSPENDED","INBOUND_PAYMENTS_RESTRICTED","PROVIDER_INITIATED","REFUND"]},"returnExplanation":{"type":"string"}}},"PartnerTransactionProgressPayload":{"type":"object","properties":{"event":{"type":"string","description":"Progress event type for the transaction","enum":["PLATFORM_VERIFIED","PAYMENT_VERIFIED","COMPLETED","CANCELLED"]},"date":{"format":"date-time","type":"string","description":"Timestamp of when the event occurred"}},"required":["event","date"]},"PartnerPaymentFundingSourceResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the funding source","format":"uuid"},"name":{"type":"string","description":"Display name of the funding source"},"type":{"type":"string","enum":["PISP"],"description":"Type of funding source"},"logo":{"type":"string","description":"Logo URL representing the funding source","nullable":true}},"required":["id","name","type"]},"PartnerPaymentExternalPayload":{"type":"object","properties":{"sourceAccountId":{"type":"string","description":"Source account id from which payment is sent","format":"uuid"},"destinationCounterparty":{"description":"Counterparty details of the payment destination","allOf":[{"$ref":"#/components/schemas/PartnerPaymentReferenceCounterpartyPayload"}]},"idempotencyKey":{"type":"string","description":"Unique key to ensure idempotency of payment requests","format":"uuid"},"amount":{"type":"number","description":"Amount in minor units (e.g. for £1.29 enter 129)"},"externalReference":{"type":"string","description":"Reference identifier provided by partner.","format":"uuid"},"description":{"type":"string","description":"Description of the payment","maxLength":140,"nullable":true},"rails":{"type":"string","default":"FASTER_PAYMENTS","description":"The payment rail to use (e.g. Faster Payments)","enum":["FASTER_PAYMENTS","CHAPS","BACS","INTERNAL","INTERNATIONAL"],"nullable":true},"railsPolicy":{"type":"string","default":"DETECT","description":"Policy for determining which rail to use","enum":["FIXED","DETECT"],"nullable":true},"verificationMetadata":{"description":"Metadata required to verify the payment request","allOf":[{"$ref":"#/components/schemas/PartnerPaymentVerificationMetadata"}]},"purpose":{"type":"string","description":"Purpose of the payment","enum":["UNKNOWN","PAYING_FAMILY_OR_FRIEND","TRANSFER_OWN_OTHER_BANK_ACCOUNT","BUY_SOMETHING","PAY_INVOICE","SALARY_OR_WAGES","GOVERNMENT_PAYMENT","TAX_PAYMENT","LOAN_REPAYMENT","BUYING_HOME_OR_PAYING_SOLICITOR","PAYING_BUILDER_OR_TRADESPERSON","INVESTMENTS","PAYING_RENT","CHARITABLE_DONATION","OTHER","TREASURY_PAYMENT","TREASURY_NETTING","CARD_SCHEME_SETTLEMENT","GENERIC_FEES","SAVINGS_PAYMENT","GIFT_PAYMENT"],"nullable":true}},"required":["sourceAccountId","destinationCounterparty","idempotencyKey","amount","externalReference","verificationMetadata"]},"PartnerPaymentFundingInitiatePayload":{"type":"object","properties":{"fundingSourceType":{"type":"string","description":"Type of funding source.","enum":["PISP"]},"fundingSourceProviderId":{"type":"string","description":"ID of the funding source provider.","format":"uuid"},"destinationAccountId":{"type":"string","description":"ID of the destination account to fund.","format":"uuid"},"externalReference":{"type":"string","description":"Reference identifier provided by partner.","format":"uuid"},"amount":{"type":"number","description":"Amount of the funding in minor units (e.g., for £1.29 enter 129)."},"idempotencyKey":{"type":"string","description":"Idempotency key to prevent duplicate funding operations.","format":"uuid"}},"required":["fundingSourceType","fundingSourceProviderId","destinationAccountId","externalReference","amount","idempotencyKey"]},"PartnerCardFundingInitiatePayload":{"type":"object","properties":{"amount":{"type":"number","description":"Amount of the funding in minor units (e.g., for £1.29 enter 129)."},"idempotencyKey":{"type":"string","description":"Idempotency key to prevent duplicate funding operations.","format":"uuid"},"externalReference":{"type":"string","description":"External reference identifier provided by partner.","format":"uuid"},"phase":{"type":"string","description":"Phase of the card transaction.","enum":["AUTHORIZATION","INCREMENTAL","ADVICE","REVERSAL","EXPIRATION_REVERSAL","CLEARING","FORCE_CLEARING"]},"type":{"type":"string","description":"Type of the card transaction. Optional but recommended for accurate reference generation.","enum":["ACTIVE_CARD_CHECK","CARD_PAYMENT","REFUND","ATM_WITHDRAWAL","ORIGINAL_CREDIT","CASHBACK","QUASI_CASH"]},"transactionToken":{"type":"string","description":"Unique reference for the card transaction, to logically group multiple events.","format":"uuid"},"eventToken":{"type":"string","description":"Unique reference for the card event.","format":"uuid"},"precedingToken":{"type":"string","description":"Preceding token for the card event.","format":"uuid","nullable":true},"sourceAccountId":{"type":"string","description":"ID of the source account.","format":"uuid"},"destinationAccountId":{"type":"string","description":"ID of the destination account.","format":"uuid"},"cardToken":{"type":"string","description":"Unique reference for the card.","format":"uuid"},"customerId":{"type":"string","description":"ID of the customer.","format":"uuid"},"lastDigits":{"type":"string","description":"Last 4 digits of the card.","pattern":"^[0-9]{4}$"},"scheme":{"description":"Card transaction scheme information (network, bin prefix, etc.).","allOf":[{"$ref":"#/components/schemas/PartnerCardTransactionScheme"}]},"cardAcceptor":{"description":"Card acceptor information (merchant details).","allOf":[{"$ref":"#/components/schemas/PartnerCardTransactionAcceptor"}]},"pos":{"description":"Point of sale information.","allOf":[{"$ref":"#/components/schemas/PartnerCardTransactionPos"}]},"approvalCode":{"type":"string","description":"Approval code."},"purchaseDate":{"format":"date-time","type":"string","description":"Date of the card transaction.","nullable":true},"exchangeRate":{"type":"string","description":"Exchange rate applied to this transaction.","nullable":true},"exchangeCurrencyCode":{"type":"string","description":"Currency used for exchange in this transaction.","enum":["AFN","EUR","ALL","DZD","USD","AOA","XCD","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","INR","BTN","BOB","BOV","BAM","BWP","NOK","BRL","BND","BGN","BIF","CVE","KHR","XAF","CAD","KYD","CLP","CLF","CNY","COP","COU","KMF","CDF","NZD","CRC","HRK","CUP","CUC","ANG","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FKP","FJD","XPF","GMD","GEL","GHS","GIP","GTQ","GBP","GNF","GYD","HTG","HNL","HKD","HUF","ISK","IDR","XDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","ZAR","LRD","LYD","CHF","MOP","MKD","MGA","MWK","MYR","MVR","MRU","MUR","XUA","MXN","MXV","MDL","MNT","MAD","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","STN","SAR","RSD","SCR","SLL","SGD","XSU","SBD","SOS","SSP","LKR","SDG","SRD","SEK","CHE","CHW","SYP","TWD","TJS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","USN","UYU","UYI","UYW","UZS","VUV","VES","VND","YER","ZMW","ZWL","XBA","XBB","XBC","XBD","XTS","XXX","XAU","XPD","XPT","XAG","AFA","FIM","ADP","ESP","FRF","AOK","AOR","RUR","ATS","AYM","AZM","BYB","BYR","BEC","BEF","BEL","BAD","BRB","BRR","BGJ","CYP","CSK","ECS","ECV","GQE","EEK","XEU","GEK","DDM","DEM","GHC","GHP","GRD","GWE","ITL","IEP","LVL","ZAL","LTL","LUC","LUF","LUL","MGF","MLF","MTL","MRO","MZE","NLG","PLZ","PTE","ROK","STD","CSD","SKK","SIT","RHD","ESA","ESB","SDD","SRG","TJR","TPE","TRL","TMM","UAK","USS","VEB","VEF","YUD","ZRN","ZMK","ZWN","ZWR"],"nullable":true}},"required":["amount","idempotencyKey","externalReference","phase","type","transactionToken","eventToken","sourceAccountId","destinationAccountId","customerId","lastDigits"]},"PartnerCommonErrorResponse":{"type":"object","properties":{"errorType":{"type":"string","enum":["VALIDATION_ERROR","FORBIDDEN","NOT_FOUND","UNAUTHORIZED","PRECONDITION_FAILED","REQUEST_TIMEOUT","SERVICE_UNAVAILABLE"]},"reason":{"type":"string","nullable":true},"validationFailures":{"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/PartnerValidationFieldError"}}},"required":["errorType"]},"PartnerValidationFieldError":{"type":"object","properties":{"message":{"type":"string"},"path":{"type":"string","nullable":true}},"required":["message"]},"PartnerPaymentErrorResponse":{"type":"object","properties":{"errorType":{"type":"string","enum":["ALREADY_PROCESS","AML_BLOCKED_INBOUND_TRANSFER","AML_BLOCKED_OUTBOUND_TRANSFER","EXCEEDS_LIMIT","INSUFFICIENT_BALANCE","INVALID_COUNTERPARTY","RAIL_NOT_SUPPORTED","RESTRICTED_INBOUND_TRANSFER","RESTRICTED_OUTBOUND_TRANSFER","TECHNICAL_ERROR","INSUFFICIENT_FUNDS","PAYMENT_NOT_RETURNABLE","UNDEFINED"]},"reason":{"type":"string","nullable":true},"validationFailures":{"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/PartnerValidationFieldError"}}},"required":["errorType"]}}}}
```