{"openapi":"3.0.0","info":{"version":"2.0","title":"Global Cash Management","description":"The Global Cash Management API allows you to manage your recipient contacts, delivery channels, and delivery methods.","contact":{"name":"API Support","email":"help@vopay.com"}},"paths":{"/gcm/recipient-contacts":{"get":{"description":"Get a list of recipient contacts for the account.","summary":"gcm/recipient-contacts","tags":["Recipient Contact Endpoints"],"operationId":"RecipientContactsGET","deprecated":false,"parameters":[{"name":"AccountID","in":"query","required":true,"description":"Your account ID","schema":{"type":"string"}},{"name":"Key","in":"query","required":true,"description":"API key for the account","schema":{"type":"string"}},{"name":"Signature","in":"query","required":true,"description":"Hashed signature for the request","schema":{"type":"string"}},{"name":"Limit","in":"query","required":false,"description":"Limit of how many recipient contacts to return","schema":{"type":"string"}},{"name":"AccountStatus","in":"query","required":false,"description":"If the account status is active or not","schema":{"type":"boolean"}},{"name":"ClientAccountID","in":"query","required":false,"description":"The client account ID that the recipients belong to","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""},"ContactClientType":{"type":"string","description":"If the contact is a individual or business","example":"individual"},"RecipientContactID":{"type":"string","description":"Contains a description of the error if the request failed","example":"test_recipient_contact"},"FirstName":{"type":"string","description":"The first name of the recipient contact","example":"first"},"LastName":{"type":"string","description":"The last name of the recipient contact","example":"last"},"BusinessName":{"type":"string","description":"The business name of the recipient contact","example":"business"},"EmailAddress":{"type":"string","description":"The email address of the recipient contact","example":"first.last@vopay.com"},"PhoneNumber":{"type":"string","description":"The phone number of the recipient contact","example":"7783630779"},"IsFavorite":{"type":"boolean","description":"If the recipient contact is a favorite","example":"false"},"Address":{"type":"string","description":"The address of the recipient contact","example":"1234 Test St"},"City":{"type":"string","description":"The city of the address","example":"Vancouver"},"PostalCode":{"type":"string","description":"The postal code of the address","example":"V6G3G9"},"Province":{"type":"string","description":"The province of the address","example":"British Colmbia"},"Country":{"type":"string","description":"The country of the address","example":"CA"},"Nationality":{"type":"string","description":"The nationality","example":"Canada"}}}}}}}}},"/gcm/recipient-contacts/add":{"post":{"description":"Add a recipient contact. All name, address, and phone fields must comply with Mastercard Cross-Border Services Data Quality Standards (effective April 20, 2026).","summary":"gcm/recipient-contacts/add","tags":["Recipient Contact Endpoints"],"operationId":"RecipientContactsAddPOST","deprecated":false,"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"AccountID":{"description":"Your account ID","type":"string"},"Key":{"description":"API key for the account","type":"string"},"Signature":{"description":"Hashed signature for the request","type":"string"},"EmailAddress":{"description":"The email address of the recipient contact","type":"string"},"ContactClientType":{"description":"If the contact is an individual or business","type":"string"},"ClientAccountID":{"description":"The client account ID the recipient belongs to","type":"string"},"RecipientContactID":{"description":"The ID for the recipient contact","type":"string"},"BusinessName":{"description":"Full legal business name of the recipient. Required if FirstName and LastName are not provided. Must be 2-60 characters and contain at least one letter. No abbreviations except standard suffixes (e.g. LLC, Ltd.).","type":"string"},"FirstName":{"description":"First name of the individual recipient. Required if BusinessName is not provided. Must be 2-60 characters using only letters, spaces, commas, apostrophes, hyphens, and dots. No initials, acronyms, or company identifiers.","type":"string"},"LastName":{"description":"Last name of the individual recipient. Required if BusinessName is not provided. Must be 2-60 characters using only letters, spaces, commas, apostrophes, hyphens, and dots. No initials, acronyms, or company identifiers.","type":"string"},"PhoneNumber":{"description":"Phone number of the recipient. Digits only, 9-15 characters. No spaces or hyphens (e.g. 19998887777).","type":"string"},"Address1":{"description":"Street address of the recipient. Must include a street name (e.g. 20 Longleat Drive). Numbers only are not accepted.","type":"string"},"Address2":{"description":"The second address line of the recipient contact","type":"string"},"City":{"description":"City of the recipient's address.","type":"string"},"Province":{"description":"The province of the address","type":"string"},"PostalCode":{"description":"The postal code of the address","type":"string"},"Country":{"description":"Country of the recipient's address. Accepts full country name or ISO 3166-1 alpha-2 or alpha-3 code. Sanctioned countries are not accepted.","type":"string"},"DateOfBirth":{"description":"Date of birth of the recipient in YYYY-MM-DD format (e.g. 1990-01-31).","type":"string"},"Nationality":{"description":"The nationality specified using full country name or ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.","type":"string"},"Language":{"description":"The language preference","type":"string"},"SourceOfIncome":{"description":"The source of income of the recipient contact","type":"string"},"Occupation":{"description":"The occupation of the recipient contact","type":"string"},"RelationshipWithBeneficiary":{"description":"The sender's relationship to the recipient contact","type":"string"}},"required":["AccountID","Key","Signature","EmailAddress","ContactClientType","PhoneNumber","Address1","City"]}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""},"RecipientContactID":{"type":"integer","description":"The unique ID of the new recipient contact.","example":"test_recipient_contact"}}}}}}}}},"/gcm/recipient-contacts/edit":{"post":{"description":"Edit a recipient contact. Any fields provided must comply with Mastercard Cross-Border Services Data Quality Standards (effective April 20, 2026).","summary":"gcm/recipient-contacts/edit","tags":["Recipient Contact Endpoints"],"operationId":"RecipientContactsEditPOST","deprecated":false,"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"AccountID":{"description":"Your account ID","type":"string"},"Key":{"description":"API key for the account","type":"string"},"Signature":{"description":"Hashed signature for the request","type":"string"},"RecipientContactID":{"description":"The recipient contact ID to edit","type":"string"},"EmailAddress":{"description":"The email address of the recipient contact","type":"string"},"BusinessName":{"description":"Full legal business name of the recipient. Must be 2-60 characters and contain at least one letter. No abbreviations except standard suffixes (e.g. LLC, Ltd.).","type":"string"},"FirstName":{"description":"First name of the individual recipient. Must be 2-60 characters using only letters, spaces, commas, apostrophes, hyphens, and dots. No initials, acronyms, or company identifiers.","type":"string"},"LastName":{"description":"Last name of the individual recipient. Must be 2-60 characters using only letters, spaces, commas, apostrophes, hyphens, and dots. No initials, acronyms, or company identifiers.","type":"string"},"PhoneNumber":{"description":"Phone number of the recipient. Digits only, 9-15 characters. No spaces or hyphens (e.g. 19998887777).","type":"string"},"Address1":{"description":"Street address of the recipient. Must include a street name (e.g. 20 Longleat Drive). Numbers only are not accepted.","type":"string"},"Address2":{"description":"The second address line of the recipient contact","type":"string"},"City":{"description":"City of the recipient's address.","type":"string"},"Province":{"description":"The province of the address","type":"string"},"PostalCode":{"description":"The postal code of the address","type":"string"},"Country":{"description":"Country of the recipient's address. Accepts full country name or ISO 3166-1 alpha-2 or alpha-3 code. Sanctioned countries are not accepted.","type":"string"},"DateOfBirth":{"description":"Date of birth of the recipient in YYYY-MM-DD format (e.g. 1990-01-31).","type":"string"},"Nationality":{"description":"The nationality specified using full country name or ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.","type":"string"},"SourceOfIncome":{"description":"The source of income of the recipient contact","type":"string"},"Occupation":{"description":"The occupation of the recipient contact","type":"string"},"RelationshipWithBeneficiary":{"description":"The sender's relationship to the recipient contact","type":"string"}},"required":["AccountID","Key","Signature","RecipientContactID"]}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""},"RecipientContactID":{"type":"integer","description":"The unique ID of the new recipient contact.","example":"test_recipient_contact"}}}}}}}}},"/gcm/recipient-contacts/favorites/add":{"post":{"description":"Add a recipient to your favorites.","summary":"gcm/recipient-contacts/favorites/add","tags":["Recipient Contact Endpoints"],"operationId":"RecipientContactsFavoritesAddPOST","deprecated":false,"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"AccountID":{"description":"Your account ID","type":"string"},"Key":{"description":"API key for the account","type":"string"},"Signature":{"description":"Hashed signature for the request","type":"string"},"RecipientContactID":{"description":"The recipient that will be favorited","type":"string"},"ClientAccountID":{"description":"The client account the favorite will be added to","type":"string"}},"required":["AccountID","Key","Signature","RecipientContactID"]}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""},"RecipientContactID":{"type":"integer","description":"The unique ID of the new recipient contact.","example":"test_recipient_contact"}}}}}}}}},"/gcm/recipient-contacts/favorites/delete":{"post":{"description":"Delete a recipient from your favorites.","summary":"gcm/recipient-contacts/favorites/delete","tags":["Recipient Contact Endpoints"],"operationId":"RecipientContactsFavoritesDeletePOST","deprecated":false,"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"AccountID":{"description":"Your account ID","type":"string"},"Key":{"description":"API key for the account","type":"string"},"Signature":{"description":"Hashed signature for the request","type":"string"},"RecipientContactID":{"description":"The recipient that will be removed from favorites","type":"string"},"ClientAccountID":{"description":"The client account the favorite will be removed from","type":"string"}},"required":["AccountID","Key","Signature","RecipientContactID"]}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""},"RecipientContactID":{"type":"integer","description":"The unique ID of the new recipient contact.","example":"test_recipient_contact"}}}}}}}}},"/gcm/countries":{"get":{"description":"Get a list of all the available countries for a specific use case that support cross border transactions.","summary":"gcm/countries","tags":["Delivery Method Endpoints"],"operationId":"CountriesGET","deprecated":false,"parameters":[{"name":"AccountID","in":"query","required":true,"description":"Your account ID","schema":{"type":"string"}},{"name":"Key","in":"query","required":true,"description":"API key for the account","schema":{"type":"string"}},{"name":"Signature","in":"query","required":true,"description":"Hashed signature for the request","schema":{"type":"string"}},{"name":"UseCase","in":"query","required":false,"description":"Valid values are B2B, B2P, P2B, P2P","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""},"Countries":{"type":"object","description":"The address details of the recipient contact","properties":{"0":{"type":"object","properties":{"CorridorID":{"type":"string","description":"The corridor ID","example":"1"},"Country":{"type":"string","description":"The country of the corridor","example":"Australia"},"DestinationCountryAbbreviation":{"type":"string","description":"The corridor country abbreviation","example":"AUS"}}}}}}}}}}}}},"/gcm/delivery-channels":{"get":{"description":"Get a list of all the available delivery methods available for a certain corridor and use case.","summary":"gcm/delivery-channels","tags":["Delivery Channel Endpoints"],"operationId":"DeliveryChannelsGET","deprecated":false,"parameters":[{"name":"AccountID","in":"query","required":true,"description":"Your account ID","schema":{"type":"string"}},{"name":"Key","in":"query","required":true,"description":"API key for the account","schema":{"type":"string"}},{"name":"Signature","in":"query","required":true,"description":"Hashed signature for the request","schema":{"type":"string"}},{"name":"CorridorID","in":"query","required":true,"description":"The corridor ID","schema":{"type":"string"}},{"name":"UseCase","in":"query","required":false,"description":"Valid values are B2B, B2P, P2B, P2P","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""},"DeliveryChannels":{"type":"object","description":"The available delivery channels","properties":{"0":{"type":"object","properties":{"DeliveryChannelID":{"type":"string","description":"The delivery channel ID","example":"5"},"DeliveryMethodType":{"type":"string","description":"The type of delivery method","example":"Bank Account"},"UseCase":{"type":"string","description":"The use case","example":"B2B"},"DeliveryFee":{"type":"string","description":"The delivery fee","example":"1.50"},"Currency":{"type":"string","description":"The currency","example":"British Pound Sterling"},"ShortForm":{"type":"string","description":"The currency short form","example":"GBP"},"DeliveryMethodTypeDetails":{"type":"string","description":"Details of the delivery method type","example":"swift"},"Notes":{"type":"string","description":"Additional notes","example":""}}}}}}}}}}}}},"/gcm/delivery-channels/fields":{"get":{"description":"Get a list of all the fields required for a certain delivery method.","summary":"gcm/delivery-channels/fields","tags":["Delivery Channel Endpoints"],"operationId":"DeliveryChannelFieldsGET","deprecated":false,"parameters":[{"name":"AccountID","in":"query","required":true,"description":"Your account ID","schema":{"type":"string"}},{"name":"Key","in":"query","required":true,"description":"API key for the account","schema":{"type":"string"}},{"name":"Signature","in":"query","required":true,"description":"Hashed signature for the request","schema":{"type":"string"}},{"name":"DeliveryChannelID","in":"query","required":true,"description":"The delivery channel ID","schema":{"type":"string"}},{"name":"FieldFor","in":"query","required":false,"description":"The field for which the details are required","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""},"DeliveryChannelFields":{"type":"object","description":"The required fields for the delivery channel","properties":{"0":{"type":"object","properties":{"Label":{"type":"string","description":"The label of the field","example":"Business Name"},"FieldID":{"type":"string","description":"The ID of the field","example":"BusinessName"},"InputType":{"type":"string","description":"The input type of the field","example":"text"},"RequirementStatus":{"type":"string","description":"The requirement status of the field","example":"required"},"FieldFor":{"type":"string","description":"The field for which the details are required","example":"sender"},"Group":{"type":"string","description":"The group of the field","example":"user-info"},"GroupOrder":{"type":"string","description":"The order of the field in the group","example":"1"},"Options":{"type":"string","description":"The options for the field, if any","example":null}}}}}}}}}}}}},"/gcm/delivery-channels/fields/data":{"get":{"description":"Get a list of all the data currently stored against a client account, contact, or recipient contact.","summary":"gcm/delivery-channels/fields/data","tags":["Delivery Channel Endpoints"],"operationId":"DeliveryChannelFieldsDataGET","deprecated":false,"parameters":[{"name":"AccountID","in":"query","required":true,"description":"Your account ID","schema":{"type":"string"}},{"name":"Key","in":"query","required":true,"description":"API key for the account","schema":{"type":"string"}},{"name":"Signature","in":"query","required":true,"description":"Hashed signature for the request","schema":{"type":"string"}},{"name":"ClientAccountID","in":"query","required":false,"description":"The client account ID","schema":{"type":"string"}},{"name":"RecipientContactID","in":"query","required":false,"description":"The recipient contact ID","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""},"DeliveryChannelFieldsData":{"type":"object","description":"The data currently stored against the client account, contact, or recipient contact","properties":{"RelationshipWithBeneficiary":{"type":"string","description":"The relationship with the beneficiary","example":"Mother"},"PurposeOfPayment":{"type":"string","description":"The purpose of the payment","example":""},"BusinessName":{"type":"string","description":"The business name","example":"Test Business"},"FirstName":{"type":"string","description":"The first name","example":"First"},"LastName":{"type":"string","description":"The last name","example":"Last"},"Address1":{"type":"string","description":"The first line of the address","example":"test address 1234"},"Address2":{"type":"string","description":"The second line of the address","example":""},"City":{"type":"string","description":"The city","example":"Vancouver"},"PostalCode":{"type":"string","description":"The postal code","example":"V6G3G9"},"Country":{"type":"string","description":"The country","example":"United States"},"Province":{"type":"string","description":"The province","example":"British Columbia"},"PhoneNumber":{"type":"string","description":"The phone number","example":"7783630779"},"EmailAddress":{"type":"string","description":"The email address","example":"first.last@gmail.com"},"Nationality":{"type":"string","description":"The nationality","example":"AUS"},"Occupation":{"type":"string","description":"The occupation","example":""},"SourceOfIncome":{"type":"string","description":"The source of income","example":""},"DateOfBirth":{"type":"string","description":"The date of birth","example":"1952-10-07"}}}}}}}}}}},"/gcm/delivery-methods":{"get":{"description":"Get a list of all the stored delivery methods for a certain recipient contact and corridor delivery method (optional).","summary":"gcm/delivery-methods","tags":["Delivery Method Endpoints"],"operationId":"DeliveryMethodsGET","deprecated":false,"parameters":[{"name":"AccountID","in":"query","required":true,"description":"Your account ID","schema":{"type":"string"}},{"name":"Key","in":"query","required":true,"description":"API key for the account","schema":{"type":"string"}},{"name":"Signature","in":"query","required":true,"description":"Hashed signature for the request","schema":{"type":"string"}},{"name":"RecipientContactID","in":"query","required":true,"description":"The recipient contact ID","schema":{"type":"string"}},{"name":"ClientAccountID","in":"query","required":false,"description":"The client account ID","schema":{"type":"string"}},{"name":"DeliveryChannelID","in":"query","required":false,"description":"The delivery channel ID","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""},"DeliveryMethods":{"type":"object","description":"The stored delivery methods","properties":{"0":{"type":"object","properties":{"DeliveryMethodToken":{"type":"string","description":"The delivery method token","example":"3aguu9elzyqs8dk9vwruv208h2ijz2vzivrggo3rnr2s07nyw4c2o6t1k3kcyskg"},"DeliveryChannelID":{"type":"string","description":"The delivery channel ID","example":"55"},"BankAccountNumber":{"type":"string","description":"The bank account number","example":"0080****"},"BankIdentifierCode":{"type":"string","description":"The bank identifier code","example":"BNPAAU2SXXX"},"InternationalBankAccountNumber":{"type":"string","description":"The international bank account number","example":""},"EWalletID":{"type":"string","description":"The e-wallet ID","example":""},"ServiceProvider":{"type":"string","description":"The service provider","example":""},"TelephoneNumber":{"type":"string","description":"The telephone number","example":""},"BankName":{"type":"string","description":"The bank name","example":""},"BankCode":{"type":"string","description":"The bank code","example":"ANZ"},"BranchName":{"type":"string","description":"The branch name","example":""},"AccountType":{"type":"string","description":"The account type","example":""},"DeliveryMethodType":{"type":"string","description":"The delivery method type","example":"Bank Account"},"DestinationCountry":{"type":"string","description":"The destination country","example":"Australia"},"DestinationCountryCode":{"type":"string","description":"The destination country code","example":"AUS"},"DestinationAbbreviation":{"type":"string","description":"The destination abbreviation","example":"AU"},"DeliveryFee":{"type":"string","description":"The delivery fee","example":"1.60"}}}}}}}}}}}}},"/gcm/delivery-methods/add":{"post":{"description":"Add a new delivery method for a certain recipient contact and corridor delivery method.","summary":"gcm/delivery-methods/add","tags":["Delivery Method Endpoints"],"operationId":"AddDeliveryMethodPOST","deprecated":false,"parameters":[{"name":"AccountID","in":"query","required":true,"description":"Your account ID","schema":{"type":"string"}},{"name":"Key","in":"query","required":true,"description":"API key for the account","schema":{"type":"string"}},{"name":"Signature","in":"query","required":true,"description":"Hashed signature for the request","schema":{"type":"string"}},{"name":"RecipientContactID","in":"query","required":true,"description":"The recipient contact ID","schema":{"type":"string"}},{"name":"DeliveryChannelID","in":"query","required":true,"description":"The delivery channel ID","schema":{"type":"string"}},{"name":"ClientAccountID","in":"query","required":false,"description":"The client account ID","schema":{"type":"string"}},{"name":"AccountType","in":"query","required":false,"description":"The account type","schema":{"type":"string"}},{"name":"BankAccountNumber","in":"query","required":false,"description":"The bank account number","schema":{"type":"string"}},{"name":"BankIdentifierCode","in":"query","required":false,"description":"The bank identifier code","schema":{"type":"string"}},{"name":"InternationalBankAccountNumber","in":"query","required":false,"description":"The international bank account number","schema":{"type":"string"}},{"name":"EWalletID","in":"query","required":false,"description":"The e-wallet ID","schema":{"type":"string"}},{"name":"ServiceProvider","in":"query","required":false,"description":"The service provider","schema":{"type":"string"}},{"name":"TelephoneNumber","in":"query","required":false,"description":"The telephone number","schema":{"type":"string"}},{"name":"BankName","in":"query","required":false,"description":"The bank name","schema":{"type":"string"}},{"name":"BankCode","in":"query","required":false,"description":"The bank code","schema":{"type":"string"}},{"name":"BranchName","in":"query","required":false,"description":"The branch name","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Error message if any","example":""},"DeliveryMethodToken":{"type":"string","description":"The token of the added delivery method","example":"374lrxtrutgk8o6qxmv94xmet28r0jle93xwkc2vmydbr65oqos1fklpeqnsni6h"},"RecipientContactID":{"type":"string","description":"The recipient contact ID","example":"test_account"}}}}}}}}},"/gcm/delivery-methods/edit":{"post":{"description":"Edit an existing delivery method for a certain recipient contact and corridor delivery method.","summary":"gcm/delivery-methods/edit","tags":["Delivery Method Endpoints"],"operationId":"EditDeliveryMethodPOST","deprecated":false,"parameters":[{"name":"AccountID","in":"query","required":true,"description":"Your account ID","schema":{"type":"string"}},{"name":"Key","in":"query","required":true,"description":"API key for the account","schema":{"type":"string"}},{"name":"Signature","in":"query","required":true,"description":"Hashed signature for the request","schema":{"type":"string"}},{"name":"DeliveryMethodToken","in":"query","required":true,"description":"The token of the delivery method to be edited","schema":{"type":"string"}},{"name":"AccountType","in":"query","required":false,"description":"The account type","schema":{"type":"string"}},{"name":"BankAccountNumber","in":"query","required":false,"description":"The bank account number","schema":{"type":"string"}},{"name":"BankIdentifierCode","in":"query","required":false,"description":"The bank identifier code","schema":{"type":"string"}},{"name":"InternationalBankAccountNumber","in":"query","required":false,"description":"The international bank account number","schema":{"type":"string"}},{"name":"EWalletID","in":"query","required":false,"description":"The e-wallet ID","schema":{"type":"string"}},{"name":"ServiceProvider","in":"query","required":false,"description":"The service provider","schema":{"type":"string"}},{"name":"TelephoneNumber","in":"query","required":false,"description":"The telephone number","schema":{"type":"string"}},{"name":"BankName","in":"query","required":false,"description":"The bank name","schema":{"type":"string"}},{"name":"BankCode","in":"query","required":false,"description":"The bank code","schema":{"type":"string"}},{"name":"BranchName","in":"query","required":false,"description":"The branch name","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Error message if any","example":""}}}}}}}}},"/gcm/delivery-methods/delete":{"post":{"description":"Delete a delivery method for a certain recipient contact.","summary":"gcm/delivery-methods/delete","tags":["Delivery Method Endpoints"],"operationId":"DeleteDeliveryMethodPOST","deprecated":false,"parameters":[{"name":"AccountID","in":"query","required":true,"description":"Your account ID","schema":{"type":"string"}},{"name":"Key","in":"query","required":true,"description":"API key for the account","schema":{"type":"string"}},{"name":"Signature","in":"query","required":true,"description":"Hashed signature for the request","schema":{"type":"string"}},{"name":"RecipientContactID","in":"query","required":true,"description":"The recipient contact ID","schema":{"type":"string"}},{"name":"DeliveryMethodToken","in":"query","required":true,"description":"The token of the delivery method to be deleted","schema":{"type":"string"}},{"name":"ClientAccountID","in":"query","required":false,"description":"The client account ID","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Error message if any","example":""}}}}}}}}},"/gcm/government-identifier":{"get":{"description":"Get a list of all the stored government identifiers for a certain client account and corridor.","summary":"gcm/government-identifier","tags":["Government Identifier Endpoints"],"operationId":"GovernmentIdentifierGET","deprecated":false,"parameters":[{"name":"AccountID","in":"query","required":true,"description":"Your account ID","schema":{"type":"string"}},{"name":"Key","in":"query","required":true,"description":"API key for the account","schema":{"type":"string"}},{"name":"Signature","in":"query","required":true,"description":"Hashed signature for the request","schema":{"type":"string"}},{"name":"CorridorID","in":"query","required":true,"description":"The corridor ID","schema":{"type":"string"}},{"name":"ClientAccountID","in":"query","required":false,"description":"The client account ID","schema":{"type":"string"}},{"name":"RecipientContactID","in":"query","required":false,"description":"The recipient contact ID","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Error message if any","example":""},"GovernmentIdentifiers":{"type":"object","description":"The stored government identifiers","properties":{"0":{"type":"object","properties":{"CorridorID":{"type":"string","description":"The corridor ID","example":"12"},"GovernmentIdentifierToken":{"type":"string","description":"The government identifier token","example":"26aeyllfka4kg2yksbyyj20cgc18wjwgip7t95qem9af3mzhxul344nfvm0ka2o0"},"GovernmentIdentifierType":{"type":"string","description":"The type of government identifier","example":"Passport Number"},"IDNumber":{"type":"string","description":"The ID number","example":"2147******"},"ExpirationDate":{"type":"string","description":"The expiration date","example":"2019-05-01"},"IssueDate":{"type":"string","description":"The issue date","example":"2011-07-12"},"IssuingCountry":{"type":"string","description":"The issuing country","example":"Canada"},"IssuingAbbreviation":{"type":"string","description":"The issuing country abbreviation","example":"CA"},"IssuingCountryCode":{"type":"string","description":"The issuing country code","example":"CAN"}}}}}}}}}}}}},"/gcm/government-identifier/schemas":{"get":{"description":"Get a list of all the available government identifier schemas.","summary":"gcm/government-identifier/schemas","tags":["Government Identifier Endpoints"],"operationId":"GovernmentIdentifierSchemasGET","deprecated":false,"parameters":[{"name":"AccountID","in":"query","required":true,"description":"Your account ID","schema":{"type":"string"}},{"name":"Key","in":"query","required":true,"description":"API key for the account","schema":{"type":"string"}},{"name":"Signature","in":"query","required":true,"description":"Hashed signature for the request","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Error message if any","example":""},"GovernmentIdentifierSchemaValues":{"type":"object","description":"The available government identifier schemas","properties":{"ppn":{"type":"string","description":"Passport Number","example":"Passport Number"},"ssn":{"type":"string","description":"Social Security Number","example":"Social Security Number"},"ein":{"type":"string","description":"Employer Identification Number","example":"Employer Identification Number"},"tin":{"type":"string","description":"Tax Identification Number","example":"Tax Identification Number"},"aln":{"type":"string","description":"Alien Registration Number","example":"Alien Registration Number"},"cus":{"type":"string","description":"Customer Number","example":"Customer Number"},"idc":{"type":"string","description":"Identity Card Number","example":"Identity Card Number"},"dln":{"type":"string","description":"Drivers License Number","example":"Drivers License Number"}}}}}}}}}}},"/gcm/government-identifier/add":{"post":{"description":"Add a new government identifier for a certain client account and corridor.","summary":"gcm/government-identifier/add","tags":["Government Identifier Endpoints"],"operationId":"AddGovernmentIdentifierPOST","deprecated":false,"parameters":[{"name":"AccountID","in":"query","required":true,"description":"Your account ID","schema":{"type":"string"}},{"name":"Key","in":"query","required":true,"description":"API key for the account","schema":{"type":"string"}},{"name":"Signature","in":"query","required":true,"description":"Hashed signature for the request","schema":{"type":"string"}},{"name":"CorridorID","in":"query","required":true,"description":"The corridor ID","schema":{"type":"string"}},{"name":"GovernmentIdentifierSchema","in":"query","required":true,"description":"The government identifier schema","schema":{"type":"string"}},{"name":"IDNumber","in":"query","required":true,"description":"The ID number","schema":{"type":"string"}},{"name":"ClientAccountID","in":"query","required":false,"description":"The client account ID","schema":{"type":"string"}},{"name":"RecipientContactID","in":"query","required":false,"description":"The recipient contact ID","schema":{"type":"string"}},{"name":"Country","in":"query","required":false,"description":"The country","schema":{"type":"string"}},{"name":"ExpirationDate","in":"query","required":false,"description":"The expiration date","schema":{"type":"string"}},{"name":"IssueDate","in":"query","required":false,"description":"The issue date","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Error message if any","example":""},"GovernmentIdentifierToken":{"type":"string","description":"The token of the added government identifier","example":"3543e6ecak8wk3770pd32kv2c37tsl5kcfpyck3u9zl6dx2h2c42ia0428n96g44"},"ClientAccountID":{"type":"string","description":"The client account ID","example":"test_account"}}}}}}}}},"/gcm/government-identifier/delete":{"post":{"description":"Delete a government identifier for a certain client account.","summary":"gcm/government-identifier/delete","tags":["Government Identifier Endpoints"],"operationId":"DeleteGovernmentIdentifierPOST","deprecated":false,"parameters":[{"name":"AccountID","in":"query","required":true,"description":"Your account ID","schema":{"type":"string"}},{"name":"Key","in":"query","required":true,"description":"API key for the account","schema":{"type":"string"}},{"name":"Signature","in":"query","required":true,"description":"Hashed signature for the request","schema":{"type":"string"}},{"name":"GovernmentIdentifierToken","in":"query","required":true,"description":"The token of the government identifier to be deleted","schema":{"type":"string"}},{"name":"ClientAccountID","in":"query","required":false,"description":"The client account ID","schema":{"type":"string"}},{"name":"RecipientContactID","in":"query","required":false,"description":"The recipient contact ID","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Error message if any","example":""}}}}}}}}},"/gcm/watchlist":{"get":{"description":"Get a list of all the watchlisted corridors for a certain client account.","summary":"gcm/watchlist","tags":["Watchlist Endpoints"],"operationId":"GetWatchlistGET","deprecated":false,"parameters":[{"name":"AccountID","in":"query","required":true,"description":"Your account ID","schema":{"type":"string"}},{"name":"Key","in":"query","required":true,"description":"API key for the account","schema":{"type":"string"}},{"name":"Signature","in":"query","required":true,"description":"Hashed signature for the request","schema":{"type":"string"}},{"name":"ClientAccountID","in":"query","required":false,"description":"The client account ID","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Error message if any","example":""},"Watchlist":{"type":"object","description":"The watchlisted corridors","properties":{"0":{"type":"object","properties":{"Currency":{"type":"string","description":"The currency","example":"Australian Dollar"},"ShortForm":{"type":"string","description":"The currency short form","example":"AUD"},"FxRate":{"type":"string","description":"The foreign exchange rate","example":"1.0839700000"}}}}}}}}}}}}},"/gcm/watchlist/rates":{"get":{"description":"Get a list of fx rates for a wacthlisted currency.","summary":"gcm/watchlist/rates","tags":["Watchlist Endpoints"],"operationId":"GetWatchlistRatesGET","deprecated":false,"parameters":[{"name":"AccountID","in":"query","required":true,"description":"Your account ID","schema":{"type":"string"}},{"name":"Key","in":"query","required":true,"description":"API key for the account","schema":{"type":"string"}},{"name":"Signature","in":"query","required":true,"description":"Hashed signature for the request","schema":{"type":"string"}},{"name":"Currency","in":"query","required":false,"description":"The currency you want to get rates for","schema":{"type":"string"}},{"name":"LookBack","in":"query","required":false,"description":"The lookback period, valid values are: day, week, month, year. Default is day","schema":{"type":"string"}},{"name":"Processor","in":"query","required":false,"description":"The processor","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Error message if any","example":""},"FxRates":{"type":"object","description":"The list of fx rates","properties":{"0":{"type":"object","properties":{"FxRate":{"type":"string","description":"The foreign exchange rate","example":"1.0839700000"},"DateAdded":{"type":"string","description":"The date the rate was added","example":"2024-08-13 21:57:28"}}}}}}}}}}}}},"/gcm/watchlist/add":{"post":{"description":"Add a new watchlisted corridor for a certain client account.","summary":"gcm/watchlist/add","tags":["Watchlist Endpoints"],"operationId":"AddWatchlistPOST","deprecated":false,"parameters":[{"name":"AccountID","in":"query","required":true,"description":"Your account ID","schema":{"type":"string"}},{"name":"Key","in":"query","required":true,"description":"API key for the account","schema":{"type":"string"}},{"name":"Signature","in":"query","required":true,"description":"Hashed signature for the request","schema":{"type":"string"}},{"name":"Currency","in":"query","required":true,"description":"The currency abbreviation","schema":{"type":"string"}},{"name":"ClientAccountID","in":"query","required":false,"description":"The client account ID","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Error message if any","example":""}}}}}}}}},"/gcm/watchlist/delete":{"post":{"description":"Delete a watchlisted corridor for a certain client account.","summary":"gcm/watchlist/delete","tags":["Watchlist Endpoints"],"operationId":"DeleteWatchlistPOST","deprecated":false,"parameters":[{"name":"AccountID","in":"query","required":true,"description":"Your account ID","schema":{"type":"string"}},{"name":"Key","in":"query","required":true,"description":"API key for the account","schema":{"type":"string"}},{"name":"Signature","in":"query","required":true,"description":"Hashed signature for the request","schema":{"type":"string"}},{"name":"Currency","in":"query","required":true,"description":"The Currency you want to delete","schema":{"type":"string"}},{"name":"ClientAccountID","in":"query","required":false,"description":"The client account ID","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Error message if any","example":""}}}}}}}}},"/gcm/withdraw/quote":{"post":{"description":"Get a quote for a certain amount to be sold or bought using a certain corridor delivery method.","summary":"gcm/withdraw/quote","tags":["Withdraw Endpoints"],"operationId":"GetQuotePOST","deprecated":false,"parameters":[{"name":"AccountID","in":"query","required":true,"description":"Your account ID","schema":{"type":"string"}},{"name":"Key","in":"query","required":true,"description":"API key for the account","schema":{"type":"string"}},{"name":"Signature","in":"query","required":true,"description":"Hashed signature for the request","schema":{"type":"string"}},{"name":"DeliveryChannelID","in":"query","required":true,"description":"The delivery channel ID","schema":{"type":"string"}},{"name":"ClientAccountID","in":"query","required":false,"description":"The client account ID","schema":{"type":"string"}},{"name":"BuyAmount","in":"query","required":false,"description":"The amount to be bought","schema":{"type":"string"}},{"name":"SellAmount","in":"query","required":false,"description":"The amount to be sold","schema":{"type":"string"}},{"name":"FeesIncluded","in":"query","required":false,"description":"Whether fees are included","schema":{"type":"boolean"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Error message if any","example":""},"Quote":{"type":"object","description":"The quote details","properties":{"CrossborderQuoteID":{"type":"string","description":"The crossborder quote ID","example":"6690052331"},"ExpiryTime":{"type":"string","description":"The expiry time of the quote","example":"2024-11-20 01:42:58"},"ChargedAmount":{"type":"string","description":"The charged amount","example":"100.00"},"PrincipalAmount":{"type":"string","description":"The principal amount","example":"98.40"},"CreditedAmount":{"type":"string","description":"The credited amount","example":"57.01"},"FXRate":{"type":"string","description":"The foreign exchange rate","example":"0.579370"},"ServiceFee":{"type":"string","description":"The service fee","example":"0.00"},"DeliveryFee":{"type":"string","description":"The delivery fee","example":"1.60"},"HasSufficientFunds":{"type":"boolean","description":"Whether there are sufficient funds","example":true}}}}}}}}}}},"/gcm/withdraw/quotes":{"get":{"description":"Get a list of withdraw quotes for a certain client account.","summary":"gcm/withdraw/quotes","tags":["Withdraw Endpoints"],"operationId":"GetWithdrawQuotesGET","deprecated":false,"parameters":[{"name":"AccountID","in":"query","required":true,"description":"Your account ID","schema":{"type":"string"}},{"name":"Key","in":"query","required":true,"description":"API key for the account","schema":{"type":"string"}},{"name":"Signature","in":"query","required":true,"description":"Hashed signature for the request","schema":{"type":"string"}},{"name":"ClientAccountID","in":"query","required":false,"description":"The client account ID","schema":{"type":"string"}},{"name":"CrossborderQuoteID","in":"query","required":false,"description":"The crossborder quote ID","schema":{"type":"string"}},{"name":"IsActive","in":"query","required":false,"description":"Whether the quote is active","schema":{"type":"boolean"}},{"name":"Limit","in":"query","required":false,"description":"The limit of quotes to fetch","schema":{"type":"integer"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Error message if any","example":""},"CrossborderQuotes":{"type":"object","description":"The list of crossborder quotes","properties":{"0":{"type":"object","properties":{"CrossborderQuoteID":{"type":"string","description":"The crossborder quote ID","example":"7915407018-local"},"ExpiryTime":{"type":"string","description":"The expiry time of the quote","example":""},"DestinationCurrency":{"type":"string","description":"The destination currency","example":"AUD"},"FXRate":{"type":"string","description":"The foreign exchange rate","example":"0.5805894309"},"IsActive":{"type":"boolean","description":"Whether the quote is active","example":"1"},"FailureReason":{"type":"string","description":"The reason for failure, if any","example":""}}}}}}}}}}}}},"/gcm/withdraw":{"post":{"description":"Create a crossborder withdrawal transaction from a provided quote.","summary":"gcm/withdraw","tags":["Withdraw Endpoints"],"operationId":"CreateWithdrawPOST","deprecated":false,"parameters":[{"name":"AccountID","in":"query","required":true,"description":"Your account ID","schema":{"type":"string"}},{"name":"Key","in":"query","required":true,"description":"API key for the account","schema":{"type":"string"}},{"name":"Signature","in":"query","required":true,"description":"Hashed signature for the request","schema":{"type":"string"}},{"name":"CrossborderQuoteID","in":"query","required":true,"description":"The crossborder quote ID","schema":{"type":"string"}},{"name":"DeliveryMethodToken","in":"query","required":true,"description":"The delivery method token","schema":{"type":"string"}},{"name":"PurposeOfPayment","in":"query","required":true,"description":"The purpose of the payment","schema":{"type":"string"}},{"name":"RelationshipWithBeneficiary","in":"query","required":false,"description":"The relationship with the beneficiary","schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"GLCode":{"description":"An optional unique identification general ledger code.","type":"string"},"TransactionTypeCode":{"description":"CPA transaction code. Use the /api/v2/account/transactions/codes endpoint to retrieve a list of valid transaction codes. If not specified, the transaction will be created using code 450 (miscellaneous).","type":"string"}}}}}},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Error message if any","example":""},"TransactionID":{"type":"string","description":"The transaction ID","example":"1234567"},"CashoutCode":{"type":"string","description":"The cashout code","example":"xzczgahodi"}}}}}}}}},"/gcm/withdraw/confirm":{"post":{"description":"Confirm a partially complete crossborder withdrawal transaction.","summary":"gcm/withdraw/confirm","tags":["Withdraw Endpoints"],"operationId":"ConfirmWithdrawPOST","deprecated":false,"parameters":[{"name":"AccountID","in":"query","required":true,"description":"Your account ID","schema":{"type":"string"}},{"name":"Key","in":"query","required":true,"description":"API key for the account","schema":{"type":"string"}},{"name":"Signature","in":"query","required":true,"description":"Hashed signature for the request","schema":{"type":"string"}},{"name":"TransactionID","in":"query","required":true,"description":"The transaction ID","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Error message if any","example":""},"TransactionID":{"type":"string","description":"The transaction ID","example":"1234567"}}}}}}}}},"/gcm/withdraw/cancel":{"post":{"description":"Cancel a partially complete crossborder withdrawal transaction.","summary":"gcm/withdraw/cancel","tags":["Withdraw Endpoints"],"operationId":"CancelWithdrawPOST","deprecated":false,"parameters":[{"name":"AccountID","in":"query","required":true,"description":"Your account ID","schema":{"type":"string"}},{"name":"Key","in":"query","required":true,"description":"API key for the account","schema":{"type":"string"}},{"name":"Signature","in":"query","required":true,"description":"Hashed signature for the request","schema":{"type":"string"}},{"name":"TransactionID","in":"query","required":true,"description":"The transaction ID","schema":{"type":"string"}},{"name":"CancellationReason","in":"query","required":true,"description":"A customer provided reason for the cancellation, this will show up in the transaction details.","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Error message if any","example":""},"TransactionID":{"type":"string","description":"The transaction ID","example":"1234567"}}}}}}}}},"/gcm/withdraw/transactions":{"get":{"description":"Get a list of crossborder withdraw transactions.","summary":"gcm/withdraw/transactions","tags":["Withdraw Endpoints"],"operationId":"GetWithdrawTransactionsGET","deprecated":false,"parameters":[{"name":"AccountID","in":"query","required":true,"description":"Your account ID","schema":{"type":"string"}},{"name":"Key","in":"query","required":true,"description":"API key for the account","schema":{"type":"string"}},{"name":"Signature","in":"query","required":true,"description":"Hashed signature for the request","schema":{"type":"string"}},{"name":"ClientAccountID","in":"query","required":false,"description":"The client account ID","schema":{"type":"string"}},{"name":"StartDateTime","in":"query","required":false,"description":"The start date and time for the transactions","schema":{"type":"string"}},{"name":"EndDateTime","in":"query","required":false,"description":"The end date and time for the transactions","schema":{"type":"string"}},{"name":"Limit","in":"query","required":false,"description":"The limit of transactions to fetch","schema":{"type":"integer"}},{"name":"Timezone ","in":"query","required":false,"description":"Use this parameter to convert the time to the specified timezone. If no timezone is specified, the default is UTC.","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Error message if any","example":""},"Transactions":{"type":"object","description":"The list of crossborder withdraw transactions","properties":{"0":{"type":"object","properties":{"TransactionID":{"type":"string","description":"The transaction ID","example":"2421928"},"DestinationCountryAbbreviation":{"type":"string","description":"The destination country abbreviation","example":"AUS"},"RecipientName":{"type":"string","description":"The recipient name","example":"First Last"},"FirstName":{"type":"string","description":"The first name","example":"First"},"LastName":{"type":"string","description":"The last name","example":"Last"},"BusinessName":{"type":"string","description":"The business name","example":"AnytimeTerrorism"},"Status":{"type":"string","description":"The status of the transaction","example":"in progress"},"DeliveryMethodType":{"type":"string","description":"The delivery method type","example":"Bank Account"},"PaymentType":{"type":"string","description":"If the payment was a buy or a sell","example":"buy"},"FeesIncluded":{"type":"string","description":"If the payment included fees or not","example":"1"},"TransactionDate":{"type":"string","description":"The date of the transaction","example":"2024-11-15 19:55:19"},"Amount":{"type":"string","description":"The amount","example":"100.00"},"PrincipalAmount":{"type":"string","description":"The principalAmount amount","example":"98.40"},"CustomerCreditedAmount":{"type":"string","description":"The credited amount","example":"57.15"},"FXRate":{"type":"string","description":"The foreign exchange rate","example":"0.5807926829"},"RecipientCurrency":{"type":"string","description":"The recipient currency","example":"AUD"},"SenderCurrency":{"type":"string","description":"The sender currency","example":"CAD"},"CorridorID":{"type":"string","description":"The corridor ID","example":"1"},"RecipientContactID":{"type":"string","description":"The recipient contact ID","example":"test_account"},"DeliveryMethodID":{"type":"string","description":"The delivery method ID","example":"2"},"DeliveryMethodToken":{"type":"string","description":"The delivery method token","example":"3aguu9elzyqs8dk9vwruv208h2ijz2vzivrggo3rnr2s07nyw4c2o6t1k3kcyskg"},"SenderPurposeOfPayment":{"type":"string","description":"The purpose of the payment","example":"Medical Expenses"},"CashoutCode":{"type":"string","description":"The cashout code","example":""},"SenderBusinessName":{"type":"string","description":"The sender's business name","example":"Test Business"},"SenderNationality":{"type":"string","description":"The sender's nationality","example":"CAN"},"SenderGovernmentIds":{"type":"string","description":"The sender's government IDs","example":"[]"},"SenderOccupation":{"type":"string","description":"The sender's occupation","example":""},"SenderRelationshipWithBeneficiary":{"type":"string","description":"The sender's relationship with the beneficiary","example":"Mother"},"SenderSourceOfIncome":{"type":"string","description":"The sender's source of income","example":""},"SenderDateOfBirth":{"type":"string","description":"The sender's date of birth","example":"1998-12-20"},"SenderFirstName":{"type":"string","description":"The sender's first name","example":""},"SenderLastName":{"type":"string","description":"The sender's last name","example":""},"SenderAddress1":{"type":"string","description":"The sender's address line 1","example":"123 Main Street"},"SenderAddress2":{"type":"string","description":"The sender's address line 2","example":""},"SenderAddressCity":{"type":"string","description":"The sender's city","example":"Vancouver"},"SenderAddressPostalCode":{"type":"string","description":"The sender's postal code","example":"V6G3G9"},"SenderAddressCountry":{"type":"string","description":"The sender's country","example":"Canada"},"SenderAddressProvince":{"type":"string","description":"The sender's province","example":"British Columbia"},"SenderEmailAddress":{"type":"string","description":"The sender's email address","example":"fist.last@vopay.com"},"RecipientFirstName":{"type":"string","description":"The recipient's first name","example":"John"},"RecipientLastName":{"type":"string","description":"The recipient's last name","example":"Doe"},"RecipientAddress1":{"type":"string","description":"The recipient's address line 1","example":"Severodvinskaya ulitsa, 14"},"RecipientAddress2":{"type":"string","description":"The recipient's address line 2","example":""},"RecipientAddressCity":{"type":"string","description":"The recipient's city","example":"Mockba"},"RecipientAddressPostalCode":{"type":"string","description":"The recipient's postal code","example":"127224"},"RecipientAddressCountry":{"type":"string","description":"The recipient's country","example":"United States"},"RecipientAddressProvince":{"type":"string","description":"The recipient's province","example":"British Columbia"},"RecipientPhone":{"type":"string","description":"The recipient's phone number","example":""},"RecipientEmailAddress":{"type":"string","description":"The recipient's email address","example":"john.doe@gmail.com"},"RecipientNationality":{"type":"string","description":"The recipient's nationality","example":"AUS"},"RecipientBusinessName":{"type":"string","description":"The recipient's business name","example":""},"RecipientGovernmentIds":{"type":"string","description":"The recipient's government IDs","example":"[{\"government_id_uri\":\"ppn:123456789;expiration-date=2019-05-01;issue-date=2011-07-12;country=CAN\"}]"},"FailureReason":{"type":"string","description":"The reason for failure, if any","example":""},"GLCode":{"type":"string","description":"General ledger code.","example":"4300"},"TransactionTypeCode":{"type":"string","description":"CPA transaction code.","example":"999"}}}}}}}}}}}}},"/gcm/withdraw/transaction":{"get":{"description":"Get the details for a crossborder withdraw transaction.","summary":"gcm/withdraw/transaction","tags":["Withdraw Endpoints"],"operationId":"GetWithdrawTransactionGET","deprecated":false,"parameters":[{"name":"AccountID","in":"query","required":true,"description":"Your account ID","schema":{"type":"string"}},{"name":"Key","in":"query","required":true,"description":"API key for the account","schema":{"type":"string"}},{"name":"Signature","in":"query","required":true,"description":"Hashed signature for the request","schema":{"type":"string"}},{"name":"TransactionID","in":"query","required":false,"description":"The transaction ID","schema":{"type":"string"}},{"name":"Timezone ","in":"query","required":false,"description":"Use this parameter to convert the time to the specified timezone. If no timezone is specified, the default is UTC.","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Error message if any","example":""},"Transaction":{"type":"object","description":"The details for a crossborder withdraw transactions","properties":{"TransactionID":{"type":"string","description":"The transaction ID","example":"2421928"},"DestinationCountryAbbreviation":{"type":"string","description":"The destination country abbreviation","example":"AUS"},"RecipientName":{"type":"string","description":"The recipient name","example":"First Last"},"FirstName":{"type":"string","description":"The first name","example":"First"},"LastName":{"type":"string","description":"The last name","example":"Last"},"BusinessName":{"type":"string","description":"The business name","example":"AnytimeTerrorism"},"Status":{"type":"string","description":"The status of the transaction","example":"in progress"},"DeliveryMethodType":{"type":"string","description":"The delivery method type","example":"Bank Account"},"PaymentType":{"type":"string","description":"If the payment was a buy or a sell","example":"buy"},"FeesIncluded":{"type":"string","description":"If the payment included fees or not","example":"1"},"TransactionDate":{"type":"string","description":"The date of the transaction","example":"2024-11-15 19:55:19"},"Amount":{"type":"string","description":"The amount","example":"100.00"},"PrincipalAmount":{"type":"string","description":"The principalAmount amount","example":"98.40"},"CustomerCreditedAmount":{"type":"string","description":"The credited amount","example":"57.15"},"FXRate":{"type":"string","description":"The foreign exchange rate","example":"0.5807926829"},"RecipientCurrency":{"type":"string","description":"The recipient currency","example":"AUD"},"SenderCurrency":{"type":"string","description":"The sender currency","example":"CAD"},"CorridorID":{"type":"string","description":"The corridor ID","example":"1"},"RecipientContactID":{"type":"string","description":"The recipient contact ID","example":"test_account"},"DeliveryMethodID":{"type":"string","description":"The delivery method ID","example":"2"},"DeliveryMethodToken":{"type":"string","description":"The delivery method token","example":"3aguu9elzyqs8dk9vwruv208h2ijz2vzivrggo3rnr2s07nyw4c2o6t1k3kcyskg"},"SenderPurposeOfPayment":{"type":"string","description":"The purpose of the payment","example":"Medical Expenses"},"CashoutCode":{"type":"string","description":"The cashout code","example":""},"SenderBusinessName":{"type":"string","description":"The sender's business name","example":"Test Business"},"SenderNationality":{"type":"string","description":"The sender's nationality","example":"CAN"},"SenderGovernmentIds":{"type":"string","description":"The sender's government IDs","example":"[]"},"SenderOccupation":{"type":"string","description":"The sender's occupation","example":""},"SenderRelationshipWithBeneficiary":{"type":"string","description":"The sender's relationship with the beneficiary","example":"Mother"},"SenderSourceOfIncome":{"type":"string","description":"The sender's source of income","example":""},"SenderDateOfBirth":{"type":"string","description":"The sender's date of birth","example":"1998-12-20"},"SenderFirstName":{"type":"string","description":"The sender's first name","example":""},"SenderLastName":{"type":"string","description":"The sender's last name","example":""},"SenderAddress1":{"type":"string","description":"The sender's address line 1","example":"123 Main Street"},"SenderAddress2":{"type":"string","description":"The sender's address line 2","example":""},"SenderAddressCity":{"type":"string","description":"The sender's city","example":"Vancouver"},"SenderAddressPostalCode":{"type":"string","description":"The sender's postal code","example":"V6G3G9"},"SenderAddressCountry":{"type":"string","description":"The sender's country","example":"Canada"},"SenderAddressProvince":{"type":"string","description":"The sender's province","example":"British Columbia"},"SenderEmailAddress":{"type":"string","description":"The sender's email address","example":"fist.last@vopay.com"},"RecipientFirstName":{"type":"string","description":"The recipient's first name","example":"John"},"RecipientLastName":{"type":"string","description":"The recipient's last name","example":"Doe"},"RecipientAddress1":{"type":"string","description":"The recipient's address line 1","example":"Severodvinskaya ulitsa, 14"},"RecipientAddress2":{"type":"string","description":"The recipient's address line 2","example":""},"RecipientAddressCity":{"type":"string","description":"The recipient's city","example":"Mockba"},"RecipientAddressPostalCode":{"type":"string","description":"The recipient's postal code","example":"127224"},"RecipientAddressCountry":{"type":"string","description":"The recipient's country","example":"United States"},"RecipientAddressProvince":{"type":"string","description":"The recipient's province","example":"British Columbia"},"RecipientPhone":{"type":"string","description":"The recipient's phone number","example":""},"RecipientEmailAddress":{"type":"string","description":"The recipient's email address","example":"john.doe@gmail.com"},"RecipientNationality":{"type":"string","description":"The recipient's nationality","example":"AUS"},"RecipientBusinessName":{"type":"string","description":"The recipient's business name","example":""},"RecipientGovernmentIds":{"type":"string","description":"The recipient's government IDs","example":"[{\"government_id_uri\":\"ppn:123456789;expiration-date=2019-05-01;issue-date=2011-07-12;country=CAN\"}]"},"FailureReason":{"type":"string","description":"The reason for failure, if any","example":""},"FundingOption":{"type":"string","description":"The type of payment method used to fund the transaction. Options are: eft, interac, creditcard, googlepay, applepay, aft, vopaybalance, and accountbalance","example":"eft"},"FundingOptionTransactionFee":{"type":"string","description":"The fee associated with the funding payment method","example":"100.00"},"FundingOptionProcessingTime":{"type":"string","description":"The processing time associated with the funding payment method","example":"realTime"},"GLCode":{"type":"string","description":"General ledger code.","example":"4300"},"TransactionTypeCode":{"type":"string","description":"CPA transaction code.","example":"999"},"FundingPaymentMethod":{"type":"object","description":"The details for the payment method used to fund the transaction (if any). Parameters returned will depend on the funding option used.","properties":{"FundingOption":{"type":"string","description":"The type of payment method used to fund the transaction. Options are: eft, interac, creditcard, googlepay, applepay, aft, vopaybalance, and accountbalance","example":"eft"}}}}}}}}}}}}},"/gcm/recall/request":{"post":{"description":"Create a recall request for the provided transaction id.","summary":"gcm/recall/request","tags":["Withdraw Endpoints"],"operationId":"RecallRequestPOST","deprecated":false,"parameters":[{"name":"AccountID","in":"query","required":true,"description":"Your account ID","schema":{"type":"string"}},{"name":"Key","in":"query","required":true,"description":"API key for the account","schema":{"type":"string"}},{"name":"Signature","in":"query","required":true,"description":"Hashed signature for the request","schema":{"type":"string"}},{"name":"TransactionID","in":"query","required":true,"description":"The transaction ID","schema":{"type":"string"}},{"name":"RecallExplanation","in":"query","required":true,"description":"A customer provided explanation for the recall.","schema":{"type":"string"}},{"name":"RecallReason","in":"query","required":true,"description":"The reason for the recall, acceptable values are: Duplicate Transaction, Incorrect Recipient Information, Incorrect Amount, Suspected Fraud, Money did not arrive to the recipient's account.","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Error message if any","example":""},"TransactionID":{"type":"string","description":"The transaction ID","example":"1234567"}}}}}}}}},"/gcm/generate-embed-url":{"post":{"description":"Generate link to the crossborder iframe.","summary":"gcm/generate-embed-url","tags":["Embedded Experience Endpoints"],"operationId":"GenerateEmbedURLPOST","deprecated":false,"parameters":[{"name":"AccountID","in":"query","required":true,"description":"Your account ID","schema":{"type":"string"}},{"name":"Key","in":"query","required":true,"description":"API key for the account","schema":{"type":"string"}},{"name":"Signature","in":"query","required":true,"description":"Hashed signature for the request","schema":{"type":"string"}},{"name":"ClientAccountID","in":"query","required":false,"description":"The client account ID","schema":{"type":"string"}},{"name":"ClientName","in":"query","required":false,"description":"The client name","schema":{"type":"string"}},{"name":"ClientReferenceNumber","in":"query","required":false,"description":"The client reference number","schema":{"type":"string"}},{"name":"DarkMode","in":"query","required":false,"description":"Whether to enable dark mode","schema":{"type":"boolean"}},{"name":"Language","in":"query","required":false,"description":"The language","schema":{"type":"string"}},{"name":"StylesheetUrl","in":"query","required":false,"description":"The stylesheet URL","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Error message if any","example":""},"Link":{"type":"string","description":"The generated embed URL","example":"http://localhost:4174/?Token=1vubj40xc5vdvq0nxocy0ndpk14sstdwovchce2k"}}}}}}}}},"/gcm/recipient-contacts/generate-embed-url":{"post":{"description":"Generate a link to the cross-border iframe for onboarding recipient contacts.","summary":"gcm/recipient-contacts/generate-embed-url","tags":["Embedded Experience Endpoints"],"operationId":"RecipientContactGenerateEmbedURLPOST","deprecated":false,"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"AccountID":{"description":"Your account ID","type":"string"},"Key":{"description":"API key for the account","type":"string"},"Signature":{"description":"Hashed signature for the request","type":"string"},"ContactClientType":{"description":"Type of contact client. Options are individual or business.","type":"string"},"ClientAccountID":{"description":"Client account ID. If not provided, the primary client account will be used.","type":"string"},"ContactID":{"description":"Contact ID. If not provided, the primary client account will be used.","type":"string"},"FirstName":{"description":"Client's first name. Required if BusinessName is not provided.","type":"string"},"LastName":{"description":"Client's last name. Required if BusinessName is not provided.","type":"string"},"BusinessName":{"description":"Client's business name. Required if FirstName and LastName are not provided.","type":"string"},"SendEmail":{"description":"Set to true to send an onboarding link via email. Default is false.","type":"boolean"},"ReceiverEmailAddress":{"description":"Recipient's email address. Required if SendEmail = true.","type":"string","format":"email"},"SendSMS":{"description":"Set to true to send an onboarding link via SMS. Default is false.","type":"boolean"},"ReceiverPhoneNumber":{"description":"Recipient's phone number. Required if SendSMS = true.","type":"string"},"RequiredPaymentMethods":{"description":"Comma-separated list of payment methods.","type":"string"},"Label":{"description":"Label to be added to the client account. If the label doesn't exist, it will be created and applied.","type":"string"}},"required":["AccountID","Key","Signature","ContactClientType"]}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""},"OnboardingLink":{"type":"string","description":"The URL of the onboarding link.","example":"https://request.vopay.com?Token=3s77vg2nwta8c3qc2rwpmmk8w03elfa7rmrsug3l"}}}}}}}}},"/gcm/banks/names":{"get":{"description":"Get a list of supported bank names.","summary":"gcm/banks/names","tags":["Recipient Lookup Endpoints"],"operationId":"BanksNamesGET","deprecated":false,"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"AccountID":{"description":"Your account ID","type":"string"},"Key":{"description":"API key for the account","type":"string"},"Signature":{"description":"Hashed signature for the request","type":"string"},"Country":{"description":"The country code for the bank names to be fetched.","type":"string"}},"required":["AccountID","Key","Signature","Country"]}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""},"BankNames":{"type":"object","description":"All the objects found for this given parameters.","properties":{"0":{"type":"string","description":"The name of the bank","example":"Australia And New Zealand Banking Group Limited"}}}}}}}}}}},"/gcm/banks/cities":{"get":{"description":"Get a list of supported bank cities.","summary":"gcm/banks/cities","tags":["Recipient Lookup Endpoints"],"operationId":"BanksCitiesGET","deprecated":false,"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"AccountID":{"description":"Your account ID","type":"string"},"Key":{"description":"API key for the account","type":"string"},"Signature":{"description":"Hashed signature for the request","type":"string"},"Country":{"description":"The country used to filter the list of banks.","type":"string"},"BankName":{"description":"The bank name used to filter the list of banks.","type":"string"}},"required":["AccountID","Key","Signature","Country"]}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""},"BankCities":{"type":"object","description":"All the objects found for this given parameters.","properties":{"0":{"type":"string","description":"The name of the city the bank is in","example":"Sydney"}}}}}}}}}}},"/gcm/banks/branches":{"get":{"description":"Get a list of supported bank branches.","summary":"gcm/banks/branches","tags":["Recipient Lookup Endpoints"],"operationId":"BanksBranchesGET","deprecated":false,"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"AccountID":{"description":"Your account ID","type":"string"},"Key":{"description":"API key for the account","type":"string"},"Signature":{"description":"Hashed signature for the request","type":"string"},"Country":{"description":"The country used to filter the list of banks.","type":"string"},"BankName":{"description":"The bank name used to filter the list of banks.","type":"string"},"City":{"description":"The city used to filter the list of banks.","type":"string"}},"required":["AccountID","Key","Signature","Country","BankName"]}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""},"BankBranches":{"type":"object","description":"All the objects found for this given parameters.","properties":{"0":{"type":"string","description":"The name of the branch","example":"Australia And New Zealand Banking Group Limited, Sydney"}}}}}}}}}}},"/gcm/banks/locations":{"get":{"description":"Get a list of supported bank locations.","summary":"gcm/banks/locations","tags":["Recipient Lookup Endpoints"],"operationId":"BanksLocationsGET","deprecated":false,"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"AccountID":{"description":"Your account ID","type":"string"},"Key":{"description":"API key for the account","type":"string"},"Signature":{"description":"Hashed signature for the request","type":"string"},"Country":{"description":"The country used to filter the list of banks.","type":"string"},"BankName":{"description":"The bank name used to filter the list of banks.","type":"string"},"City":{"description":"The city used to filter the list of banks.","type":"string"},"BranchName":{"description":"The branch name used to filter the list of banks.","type":"string"}},"required":["AccountID","Key","Signature","Country","BankName"]}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""},"BankLocations":{"type":"object","description":"All the objects found for this given parameters.","properties":{"0":{"type":"object","properties":{"BicCode":{"type":"string","description":"The assigned BIC code","example":"ANZBAUS1XXX"},"BankName":{"type":"string","description":"The full bank name","example":"Australia And New Zealand Banking Group Limited"},"BranchName":{"type":"string","description":"The full branch name","example":"Australia And New Zealand Banking Group Limited, Sydney"},"Address":{"type":"string","description":"The branches address","example":"ANZ Tower, 242 Pitt Street NSW 2000, Australia"},"City":{"type":"string","description":"The city","example":"Sydney"},"State":{"type":"string","description":"The state","example":"NSW"},"Phone":{"type":"string","description":"The phone number","example":"+61 3 9273 5555"}}}}}}}}}}}}}},"servers":[{"url":"https://earthnode-dev.vopay.com/api/v2"}]}