Example Payloads
Payload structure
Webhooks of event type "created" will send the same data as the object returned when sending a POST request to a resource. All webhooks of event type "updated" will send the same data as the object returned when sending a GET request to a resource.
Customer
{
"eventId": "cm628749927yhiuvnnvxvc",
"eventType": "customer.created",
"eventObject": {
"id": "cm41n4amh0001113u1k684yzb",
"createdAt": "2024-11-28T18:20:37.193Z",
"updatedAt": "2024-11-28T18:20:37.193Z",
"type": "INDIVIDUAL",
"kycStatus": "APPROVED",
"kycUrl": "https://verify.walapay.io/kyc/123",
"tosUrl": "https://verify.walapay.io/tos/123",
"firstName": "John",
"middleName": "Robert",
"lastName": "Doe",
"transliteratedFirstName": "Jon",
"transliteratedMiddleName": "Robato",
"transliteratedLastName": "Dou",
"email": "[email protected]",
"phone": "+1234567890",
"phoneCountryCode": "US",
"address": {
"streetLine1": "123 Main St",
"streetLine2": "Apt 4B",
"city": "New York",
"stateRegionOrProvince": "NY",
"postalCode": "10001",
"countryCode": "US"
},
"transliteratedAddress": {
"streetLine1": "123 メイン通り",
"streetLine2": "4B号室",
"city": "ニューヨーク",
"stateRegionOrProvince": "ニューヨーク州",
"postalCode": "10001",
"countryCode": "US"
},
"dateOfBirth": "1990-01-01",
"employmentStatus": "EMPLOYED",
"mostRecentOccupation": "15-1252",
"sourceOfFunds": "EMPLOYMENT_INCOME",
"accountPurpose": "BUSINESS_OPERATIONS",
"accountPurposeExplanation": "Receiving salary payments and paying personal expenses",
"expectedMonthlyPaymentsUSD": "UNDER_10K",
"taxIdentificationNumber": "123-45-6789",
"governmentIssuedIdentification": {
"type": "PASSPORT",
"countryCode": "CountryCode.US",
"number": "P123456789",
"issuanceDate": "2020-01-01",
"expirationDate": "2030-01-01",
"frontImage": "data:image/jpeg;base64,...",
"backImage": "data:image/jpeg;base64,...",
"livenessCheckImage": "data:image/jpeg;base64,..."
},
"supportingDocuments": [
{
"type": "PROOF_OF_ADDRESS",
"file": "data:image/jpeg;base64,...",
"description": "Utility Bill"
},
{
"type": "PROOF_OF_SOURCE_OF_FUNDS",
"file": "data:image/jpeg;base64,...",
"description": "Bank Statement"
}
],
"submissionIssues": []
}
}Account
External Bank Account Creation
{
"eventId": "cm628749927yhiuvnnvxvc",
"eventType": "account.created",
"eventObject": {
"id": "cm5oryra800013x6gvfs42euh",
"createdAt": "2025-01-09T03:34:41.313Z",
"updatedAt": "2025-01-09T03:34:41.830Z",
"currencyCode": "USD",
"status": "APPROVED",
"type": "EXTERNAL_BANK_ACCOUNT",
"digitalAssetWallet": null,
"eWallet": null,
"isDefault": false,
"bank": {
"accountNumber": "123456789",
"accountType": "CHECKING",
"address": {
"city": "Cincinnati",
"countryCode": "US",
"postalCode": "45202",
"stateOrProvince": "OH",
"streetLine1": "425 Walnut Street",
"streetLine2": null
},
"bankCode": null,
"bicSwift": null,
"branchCode": null,
"bsbNumber": null,
"clabeNumber": null,
"clearingCode": null,
"cnapsCode": null,
"iban": null,
"ifscCode": null,
"name": "U.S. Bank",
"nccNumber": null,
"nubanCode": null,
"pixCode": null,
"routingNumber": "021000089",
"sortCode": null,
"transitNumber": null
},
"paymentAccountHolder": {
"address": {
"city": "Cincinnati",
"countryCode": "US",
"postalCode": "45202",
"stateOrProvince": "OH",
"streetLine1": "123 Main Street",
"streetLine2": null
},
"email": "[email protected]",
"firstName": "John",
"lastName": "Doe",
"middleName": null,
"phone": null,
"type": "INDIVIDUAL"
}
}
}Virtual Bank Account Creation
{
"eventId": "cm628749927yhiuvnnvxvc",
"eventType": "account.created",
"eventObject": {
"id": "cm40psd0g0001xnyhdy6nmzmj",
"createdAt": "2024-11-28T02:47:33.088Z",
"updatedAt": "2024-11-28T02:47:33.088Z",
"type": "VIRTUAL_BANK_ACCOUNT",
"currencyCode": "USD",
"status": "PENDING"
}
}Virtual Bank Account Update
Once a virtual bank account has been provisioned, you will receive an update that will then include all the bank and account holder information.
{
"eventId": "cm628749927yhiuvnnvxvc",
"eventType": "account.updated",
"eventObject": {
"id": "cm5oryra800013x6gvfs42euh",
"createdAt": "2025-01-09T03:34:41.313Z",
"updatedAt": "2025-01-09T03:34:41.830Z",
"currencyCode": "USD",
"status": "APPROVED",
"type": "EXTERNAL_BANK_ACCOUNT",
"digitalAssetWallet": null,
"eWallet": null,
"isDefault": false,
"bank": {
"accountNumber": "123456789",
"accountType": "CHECKING",
"address": {
"city": "Cincinnati",
"countryCode": "US",
"postalCode": "45202",
"stateOrProvince": "OH",
"streetLine1": "425 Walnut Street",
"streetLine2": null
},
"bankCode": null,
"bicSwift": null,
"branchCode": null,
"bsbNumber": null,
"clabeNumber": null,
"clearingCode": null,
"cnapsCode": null,
"iban": null,
"ifscCode": null,
"name": "U.S. Bank",
"nccNumber": null,
"nubanCode": null,
"pixCode": null,
"routingNumber": "021000089",
"sortCode": null,
"transitNumber": null
},
"paymentAccountHolder": {
"address": {
"city": "Cincinnati",
"countryCode": "US",
"postalCode": "45202",
"stateOrProvince": "OH",
"streetLine1": "123 Main Street",
"streetLine2": null
},
"email": "[email protected]",
"firstName": "John",
"lastName": "Doe",
"middleName": null,
"phone": null,
"type": "INDIVIDUAL"
}
}
}Virtual Digital Asset Wallet Creation
{
"eventId": "cm628749927yhiuvnnvxvc",
"eventType": "account.created",
"eventObject": {
"id": "cm40psd0g0001xnyhdy6nmzmj",
"createdAt": "2024-11-28T02:47:33.088Z",
"updatedAt": "2024-11-28T02:47:33.088Z",
"type": "VIRTUAL_DIGITAL_ASSET_WALLET",
"chain": "POLYGON",
"address": "0x123456789987654rfghjuytgh",
"status": "APPROVED"
}
}Payment
{
"eventId": "cm628749927yhiuvnnvxvc",
"eventType": "payment.created",
"eventObject": {
"id": "fxmvke3wjy47kbe3alerlete",
"customerId": "cm5e74nqk0003x228bspddfe8",
"status": "PROCESSING",
"comment": null,
"paymentReason": null,
"sourceOfFunds": null,
"estimatedTotalFeeInSourceCurrency": 1.08,
"source": {
"amount": 10,
"estimatedAmount": 10,
"currencyCode": "USDC",
"accountId": "cm6086zsq0001yia29tqj2sre",
"rail": "CRYPTO",
"chain": "POLYGON"
},
"destination": {
"estimatedAmount": 182.97614592,
"currencyCode": "MXN",
"rail": "LOCAL",
"accountId": "cm5jkkkoe00054wd060pu62zq"
}
}
}Updated about 1 month ago