Direct Payout - Obtaining the Account

Understanding how to identify the customer bank

To make a Direct Payout the merchant will need to specify which bank account the customer can use - the account in this case is specified using an accountId which obtained from either making a Payin or making an Account verification. Both mechanisms will assure the bank account is valid.

The accountId is required for the second step - or API call - of the Instant Payouts - Direct Instruction.

Payins

When the customer makes an Enhanced Instant Payment, the customers bank details are captured during the settlement part of the payment - ie when the pay-in settled into the merchant bank account. At this point Yaspa will send the merchant a PAYIN_COMPLETE Webhook, this will contain the accountId. The customerAccountId can be used for the payout to this customer.

{
"type": "PAYIN_COMPLETE",
"data": {
	"citizenTransactionId": "aad08fb8-103e-18d9-5b72-646193",
	"merchantId": "652aaf857f22e864615f6ac9",
	"merchantTradingName": "Yaspa Test Merchant",
	"customerIdentifier": "Customer123"
	"version": "2"
	"journeyType": "ENHANCED_PAY_IN",
	"transactionType": "PAYIN",
	"transactionStatus": "COMPLETE",
	"creationDate": 1727796312710,
	"language": "en",
	"showReceipt": false,
	"paymentMethod": "OTHER",
	"paymentGiro": "FPS"
	"customerAccountId":"c2918586-01c-4b61-9325-edbebc286075",
	"customerAccountNumber": "12345678",
	"customerBankCode": "123456"
	"paymentAmount": "0.01",
	"paymentCurrency": "GBP",
	"reference": "cflOfwc91lr8",
	"paymentProvider": "CITIZEN_TEST_BANK",
	"finalIsoStatusCode": "ACSC",
	"metaData": ()
}

Account Verifications

Merchants can perform an Account Verification call to get details of the customer bank accounts, and then use the id field within the Accounts as the accountId

{
	"type": "ACCOUNT_VERIFICATION_DECISION",
	"data": {
		"citizenTransactionId": "0980811-29c-4d57-58dc-c9007d",
		"merchantId": "652aaf857f22e864615f6ac9",
		"merchantTradingName": "Yaspa Test Merchant",
		"customerIdentifier": "Customer123",
		"financialServiceProvider": "CITIZEN_TEST_BANK",
		"version": "2'
		"transactionType": "ACCOUNT_VERIFICATION",
		"transactionStatus": "ACCEPTED",
		"creationDate": 1727795488440,
		"language": "en"
		"accounts": [
      {
				"id": "c291858b-0e1c-4b61-9325-ed6ebc286075",
				"accountName": "GBP Deposit Account",
				"number": "12345678",
				"sortCode": "123456",
				"balance": "10.00",
				"type": "CURRENT",
				"bank":"CITIZEN TEST BANK"
      }
	]
  }
}