VoPay Global Cash Management API

{"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

# --- truncated at 32 KB (79 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vopay/refs/heads/main/openapi/vopay-global-cash-management.json