Payment Method API

Create and manage payment methods for beneficiaries. Payment methods define how funds are delivered to a beneficiary (bank account, PIX, mobile money, etc.).

Payment methods represent the delivery mechanism for funds to a beneficiary. Each payment method is associated with a beneficiary and contains the details needed to deliver funds (e.g., bank account number, PIX key, mobile phone number).

Payment Method Types

Type	Description	Key Fields
`bank_account`	Traditional bank transfer	`accountNumber`, plus country-specific fields (`routingNumber`, `sortCode`, `bic`, `ifscCode`, etc.)
`pix`	Brazilian instant payment	`pixKeyId`, `taxId`
`instapay`	Philippine instant payment	`channelSubject`, `extendInfo`
`swiftpay_pesonet`	Philippine batch payment	`channelSubject`, `extendInfo`
`spei`	Mexican interbank transfer	`targetBankAccountId`, `targetName`
`mobile_money`	Mobile money transfer	`phone`
`crypto_wallet`	Cryptocurrency wallet	`address`, `chain`

Payment Method Lifecycle

Create — Payment method is created with status compliance_review_required
Review — Compliance review is performed automatically
Consent (optional) — If requiresUserConsent is set, status becomes pending_user_consent
Approved/Declined — Payment method is approved or declined
Inactive — Payment method can be deactivated

Statuses

Status	Description
`compliance_review_required`	Awaiting compliance review
`pending_user_consent`	Requires user consent decision
`approved`	Ready to use for orders
`declined`	Declined during review
`inactive`	Deactivated