API Description

The REST APIs provide programmatic access to read, update and delete data. Create new merchants, transactions and more. The responses are returned in any format (XML, SOAP, JSON, FORM encoding) desired by the client.

The documentation is divided into sections. Merchant Resources include all resources that a merchant would need to use in day to day operation, Vendor resources are for referrers. More complex tools, like Automated Decisions and Risk Management are listed under More Resources.

Authentication

In order to authenticate your access to the API, an API key or Session key must be sent in the request.

Authentication is sent in the APIKEY header for API keys or in the SESSION header for session keys. If you are using our SDK, there is a convenient method to automatically set this for all your requests.

NOTE: API keys can be managed in the portal. These keys grant full access to your account, and should not be shared or revealed in publicly accessible areas such as GitHub, client-side code, etc.

Searching

To filter or sort the list of resources that the method returns, use the 'search' parameter. For example, to find all resources that have a property of 'public' set to '1', set this header to 'public[equals]=1' .


Operators
'equals' Retrieve results that match the input string. If the input string is empty the search will return null matches as well.
'exact' Retrieve results that are an exact match. If the input string is 'null' only null matches will be returned, otherwise only exact matches will be returned.
'Greater' Retrieve results that are higher than the variable
'Less' Retrieve results that are lower than the variable
'Like' Retrieve results that are like the variable
'in' Retrieve results that are in the variable
'sort' Sort the retrieved results, used together with 'asc' and 'desc' to sort the results by ascending or descending order, respectively.

You may also use explicit 'and/or' querying by passing arrays of 'or' and arrays of 'and' searches. For example, to find all resources that have a property of 'public' set to '1' or a property of 'active' set to '0' , set this header to 'or[][public][equals]=1&or[][active][equals]=0' .

Pagination

Set the page[number] query parameter to request a specific page of records. For example, set '?page[number]=2' to retrieve the second page of records for this request.


Operators
'number'
Query parameter to request a specific page of records
'limit'
Limit the number of items to request per page, max is 100 items per page
Expanding

To retrieve nested objects and return them as part of the response, use the 'expand' parameter. The parameter name that you specify determines the resources to return. For example, set '?expand[login][]' to return a nested login resource. The expand parameter is available on all GET requests.

Insert an empty bracket [] when expanding nested objects in an expanded array. Example: '?expand[orgEntities][][org][]'

Integration Resources
PHP SDK
Download
Installation Instructions

1. Create the composer.json file:


{
  "require": {
    ""
  }
}


2. To install the package as a dependency for your project, run the install command:


php composer.phar install
.NET SDK
Download
Installation Instructions

1. Open the project/solution in Visual Studio, and open the console using the Tools > NuGet Package Manager > Package Manager Console command.


2. Run the install command:


Install-Package -ProjectName MyProject
Ruby SDK
Download
Installation Instructions

The install command downloads and installs the gem:


$ gem install
SOAP WSDL Location
https://api.payrix.com/describe?format=soap
Merchants Resources

These resources facilitate day-to-day merchant activities, including: updating their merchant information, creating transactions, requesting payouts, etc.

Accounts


Available Actions
Query
GET /accounts or /accounts/{id}
Update
PUT /accounts/{id}
Delete
DELETE /accounts/{id}
Create
POST /accounts
Create  Accounts

Create an Account. An Account represents a bank account associated with an Entity.


entity
Required
The identifier of the Entity associated with this Account.

account
Required
An object representing details of the Account, including the type of Account (method), Account number and routing code.

method
Optional
The type of the Account.

Valid Values
'8' Checking
'9' Savings
'10' Corporate Checking
'11' Corporate Savings

number
Optional
The number of the bank account.

routing
Optional
The routing number of the bank account.


name
Optional
A client-supplied name for this bank account.

description
Optional
A client-supplied description for this bank account.

primary
Required
Indicates whether the Account is the 'primary' Account for the associated Entity. Only one Account associated with each Entity can be the 'primary' Account.

Valid Values
'0' Not primary
'1' Primary

status
Required
The status of the Account

Valid Values
'0' Pending
'1' Approved
'2' Failed
'3' Captured
'4' Settled

currency
Required
The currency of this Account.

Valid Values
'AED' United Arab Emirates dirham
'AFN' Afghan afghani
'ALL' Albanian lek
'AMD' Armenian dram
'ANG' Netherlands Antillean guilder
'AOA' Angolan kwanza
'ARS' Argentine peso
'AUD' Australian dollar
'AWG' Aruban florin
'AZN' Azerbaijani manat
'BAM' Bosnia and Herzegovina convertible mark
'BBD' Barbados dollar
'BDT' Bangladeshi taka
'BGN' Bulgarian lev
'BHD' Bahraini dinar
'BIF' Burundian franc
'BMD' Bermudian dollar
'BND' Brunei dollar
'BOB' Boliviano
'BOV' Bolivian Mvdol
'BRL' Brazilian real
'BSD' Bahamian dollar
'BTN' Bhutanese ngultrum
'BWP' Botswana pula
'BYN' Belarusian ruble
'BZD' Belize dollar
'CAD' Canadian dollar
'CDF' Congolese franc
'CHE' WIR Euro
'CHF' Swiss franc
'CHW' WIR Franc
'CLF' Unidad de Fomento
'CLP' Chilean peso
'CNY' Renminbi (Chinese) yuan
'COP' Colombian peso
'COU' Unidad de Valor Real
'CRC' Costa Rican colon
'CUC' Cuban convertible peso
'CUP' Cuban peso
'CVE' Cape Verde escudo
'CZK' Czech koruna
'DJF' Djiboutian franc
'DKK' Danish krone
'DOP' Dominican peso
'DZD' Algerian dinar
'EGP' Egyptian pound
'ERN' Eritrean nakfa
'ETB' Ethiopian birr
'EUR' Euro
'FJD' Fiji dollar
'FKP' Falkland Islands pound
'GBP' Pound sterling
'GEL' Georgian lari
'GHS' Ghanaian cedi
'GIP' Gibraltar pound
'GMD' Gambian dalasi
'GNF' Guinean franc
'GTQ' Guatemalan quetzal
'GYD' Guyanese dollar
'HKD' Hong Kong dollar
'HNL' Honduran lempira
'HRK' Croatian kuna
'HTG' Haitian gourde
'HUF' Hungarian forint
'IDR' Indonesian rupiah
'ILS' Israeli new shekel
'INR' Indian rupee
'IQD' Iraqi dinar
'IRR' Iranian rial
'ISK' Icelandic króna
'JMD' Jamaican dollar
'JOD' Jordanian dinar
'JPY' Japanese yen
'KES' Kenyan shilling
'KGS' Kyrgyzstani som
'KHR' Cambodian riel
'KMF' Comoro franc
'KPW' North Korean won
'KRW' South Korean won
'KWD' Kuwaiti dinar
'KYD' Cayman Islands dollar
'KZT' Kazakhstani tenge
'LAK' Lao kip
'LBP' Lebanese pound
'LKR' Sri Lankan rupee
'LRD' Liberian dollar
'LSL' Lesotho loti
'LYD' Libyan dinar
'MAD' Moroccan dirham
'MDL' Moldovan leu
'MGA' Malagasy ariary
'MKD' Macedonian denar
'MMK' Myanmar kyat
'MNT' Mongolian tögrög
'MOP' Macanese pataca
'MRU' Mauritanian ouguiya
'MUR' Mauritian rupee
'MVR' Maldivian rufiyaa
'MWK' Malawian kwacha
'MXN' Mexican peso
'MXV' Mexican Unidad de Inversion
'MYR' Malaysian ringgit
'MZN' Mozambican metical
'NAD' Namibian dollar
'NGN' Nigerian naira
'NIO' Nicaraguan córdoba
'NOK' Norwegian krone
'NPR' Nepalese rupee
'NZD' New Zealand dollar
'OMR' Omani rial
'PAB' Panamanian balboa
'PEN' Peruvian sol
'PGK' Papua New Guinean kina
'PHP' Philippine piso
'PKR' Pakistani rupee
'PLN' Polish złoty
'PYG' Paraguayan guaraní
'QAR' Qatari riyal
'RON' Romanian leu
'RSD' Serbian dinar
'RUB' Russian ruble
'RWF' Rwandan franc
'SAR' Saudi riyal
'SBD' Solomon Islands dollar
'SCR' Seychelles rupee
'SDG' Sudanese pound
'SEK' Swedish krona/kronor
'SGD' Singapore dollar
'SHP' Saint Helena pound
'SLL' Sierra Leonean leone
'SOS' Somali shilling
'SRD' Surinamese dollar
'SSP' South Sudanese pound
'STN' São Tomé and Príncipe dobra
'SVC' Salvadoran colón
'SYP' Syrian pound
'SZL' Swazi lilangeni
'THB' Thai baht
'TJS' Tajikistani somoni
'TMT' Turkmenistan manat
'TND' Tunisian dinar
'TOP' Tongan pa'anga
'TRY' Turkish lira
'TTD' Trinidad and Tobago dollar
'TWD' New Taiwan dollar
'TZS' Tanzanian shilling
'UAH' Ukrainian hryvnia
'UGX' Ugandan shilling
'USD' United States dollar
'USN' United States dollar
'UYI' Uruguay Peso en Unidades Indexadas
'UYU' Uruguayan peso
'UZS' Uzbekistan som
'VEF' Venezuelan bolívar
'VND' Vietnamese đồng
'VUV' Vanuatu vatu
'WST' Samoan tala
'XAF' CFA franc BEAC
'XAG' Silver
'XAU' Gold
'XBA' European Composite Unit
'XBB' European Monetary Unit
'XBC' European Unit of Account
'XBD' European Unit of Account
'XCD' East Caribbean dollar
'XDR' Special drawing rights
'XOF' CFA franc BCEAO
'XPD' Palladium
'XPF' CFP franc
'XPT' Platinum
'XSU' SUCRE
'XTS'
'XUA' ADB Unit of Account
'XXX'
'YER' Yemeni rial
'ZAR' South African rand
'ZMW' Zambian kwacha
'ZWL' Zimbabwean dollar

inactive
Required
Whether this resource is marked as inactive.

Valid Values
'0' Active
'1' Inactive

frozen
Required
Whether this resource is marked as frozen.

Valid Values
'0' Not frozen
'1' Frozen

Example request


curl

https://api.payrix.com/accounts \


-H APIKEY: nsub8et5IuJ7JP3lvsWrQbK \
-d entity="p1_ent_5a1ef5e5565631155c95344" \
-d primary="1" \
-d account[method]="8" \
-d account[number]="0123456789012345" \
-d account[routing]="063013924"



Example request

\Payrix\Utilities\Config::setApiKey("nsub8et5IuJ7JP3lvsWrQbK");

$object = new \Payrix\accounts(

array (

'entity' => "p1_ent_5a1ef5e5565631155c95344",

'primary' => 1,

'account' => array(

'method' => 8,

'number' => "0123456789012345",

'routing' => "063013924"

)

)

);


try {

}

catch (\Payrix\Exceptions\Base $e) {

// Handle exceptions

}

Example request

using System;

using Payrix;

using Payrix.Utilities;

Config.ApiKey = "nsub8et5IuJ7JP3lvsWrQbK";

var accounts = new Accounts

{

Entity = "p1_ent_5a1ef5e5565631155c95344",

Primary = 1,

Account = new TokensPayment()

{

Method = 8,

Number = "0123456789012345",

Routing = "063013924"

}

}


var success = accounts.Create();

Example request

config.api_key = "nsub8et5IuJ7JP3lvsWrQbK"

object = Payrix.Resource.Accounts.new( params {

'entity': "p1_ent_5a1ef5e5565631155c95344",

'primary': 1,

'account' => (

{

'method': 8,

'number': "0123456789012345",

'routing': "063013924"

}

)

})


begin

rescue

# Handle errors

end

Update  Accounts

Update an Account. An Account represents a bank account associated with an Entity.


account
Required
An object representing details of the Account, including the type of Account (method), Account number and routing code.

method
Optional
The type of the Account.

Valid Values
'8' Checking
'9' Savings
'10' Corporate Checking
'11' Corporate Savings

number
Optional
The number of the bank account.

routing
Optional
The routing number of the bank account.


name
Optional
A client-supplied name for this bank account.

description
Optional
A client-supplied description for this bank account.

primary
Required
Indicates whether the Account is the 'primary' Account for the associated Entity. Only one Account associated with each Entity can be the 'primary' Account.

Valid Values
'0' Not primary
'1' Primary

status
Required
The status of the Account

Valid Values
'0' Pending
'1' Approved
'2' Failed
'3' Captured
'4' Settled

inactive
Required
Whether this resource is marked as inactive.

Valid Values
'0' Active
'1' Inactive

frozen
Required
Whether this resource is marked as frozen.

Valid Values
'0' Not frozen
'1' Frozen

Example request


curl

https://api.payrix.com/accounts/p1_act_5a1ef5e55656698eefaf8b6 \


-H APIKEY: nsub8et5IuJ7JP3lvsWrQbK \
-d name="TD Bank"



Example request

\Payrix\Utilities\Config::setApiKey("nsub8et5IuJ7JP3lvsWrQbK");

$object = new \Payrix\accounts(

array (

'id' => "p1_act_5a1ef5e55656698eefaf8b6",

'name' => "TD Bank"

)

);


try {

}

catch (\Payrix\Exceptions\Base $e) {

// Handle exceptions

}

Example request

using System;

using Payrix;

using Payrix.Utilities;

Config.ApiKey = "nsub8et5IuJ7JP3lvsWrQbK";

var accounts = new Accounts

{

Id = "p1_act_5a1ef5e55656698eefaf8b6",

Name = "TD Bank"

}


var success = accounts.Update();

Example request

config.api_key = "nsub8et5IuJ7JP3lvsWrQbK"

object = Payrix.Resource.Accounts.new( params {

'id': "p1_act_5a1ef5e55656698eefaf8b6",

'name': "TD Bank"

})


begin

rescue

# Handle errors

end

Accounts Response

id
The ID of this resource.

created
The date and time at which this resource was created.

modified
The date and time at which this resource was modified.

creator
The identifier of the Login that created this resource.

modifier
The identifier of the Login that last modified this resource.

entity
The identifier of the Entity associated with this Account.

account
An object representing details of the Account, including the type of Account (method), Account number and routing code.
method
Optional
The type of the Account.

Valid Values
'8' Checking
'9' Savings
'10' Corporate Checking
'11' Corporate Savings

number
Optional
The number of the bank account.

routing
Optional
The routing number of the bank account.


token
A unique token that can be used to refer to this Account in other parts of the API.

name
A client-supplied name for this bank account.

description
A client-supplied description for this bank account.

primary
Indicates whether the Account is the 'primary' Account for the associated Entity. Only one Account associated with each Entity can be the 'primary' Account.

Valid Values
'0' Not primary
'1' Primary

status
The status of the Account

Valid Values
'0' Pending
'1' Approved
'2' Failed
'3' Captured
'4' Settled

currency
The currency of this Account.

Valid Values
'AED' United Arab Emirates dirham
'AFN' Afghan afghani
'ALL' Albanian lek
'AMD' Armenian dram
'ANG' Netherlands Antillean guilder
'AOA' Angolan kwanza
'ARS' Argentine peso
'AUD' Australian dollar
'AWG' Aruban florin
'AZN' Azerbaijani manat
'BAM' Bosnia and Herzegovina convertible mark
'BBD' Barbados dollar
'BDT' Bangladeshi taka
'BGN' Bulgarian lev
'BHD' Bahraini dinar
'BIF' Burundian franc
'BMD' Bermudian dollar
'BND' Brunei dollar
'BOB' Boliviano
'BOV' Bolivian Mvdol
'BRL' Brazilian real
'BSD' Bahamian dollar
'BTN' Bhutanese ngultrum
'BWP' Botswana pula
'BYN' Belarusian ruble
'BZD' Belize dollar
'CAD' Canadian dollar
'CDF' Congolese franc
'CHE' WIR Euro
'CHF' Swiss franc
'CHW' WIR Franc
'CLF' Unidad de Fomento
'CLP' Chilean peso
'CNY' Renminbi (Chinese) yuan
'COP' Colombian peso
'COU' Unidad de Valor Real
'CRC' Costa Rican colon
'CUC' Cuban convertible peso
'CUP' Cuban peso
'CVE' Cape Verde escudo
'CZK' Czech koruna
'DJF' Djiboutian franc
'DKK' Danish krone
'DOP' Dominican peso
'DZD' Algerian dinar
'EGP' Egyptian pound
'ERN' Eritrean nakfa
'ETB' Ethiopian birr
'EUR' Euro
'FJD' Fiji dollar
'FKP' Falkland Islands pound
'GBP' Pound sterling
'GEL' Georgian lari
'GHS' Ghanaian cedi
'GIP' Gibraltar pound
'GMD' Gambian dalasi
'GNF' Guinean franc
'GTQ' Guatemalan quetzal
'GYD' Guyanese dollar
'HKD' Hong Kong dollar
'HNL' Honduran lempira
'HRK' Croatian kuna
'HTG' Haitian gourde
'HUF' Hungarian forint
'IDR' Indonesian rupiah
'ILS' Israeli new shekel
'INR' Indian rupee
'IQD' Iraqi dinar
'IRR' Iranian rial
'ISK' Icelandic króna
'JMD' Jamaican dollar
'JOD' Jordanian dinar
'JPY' Japanese yen
'KES' Kenyan shilling
'KGS' Kyrgyzstani som
'KHR' Cambodian riel
'KMF' Comoro franc
'KPW' North Korean won
'KRW' South Korean won
'KWD' Kuwaiti dinar
'KYD' Cayman Islands dollar
'KZT' Kazakhstani tenge
'LAK' Lao kip
'LBP' Lebanese pound
'LKR' Sri Lankan rupee
'LRD' Liberian dollar
'LSL' Lesotho loti
'LYD' Libyan dinar
'MAD' Moroccan dirham
'MDL' Moldovan leu
'MGA' Malagasy ariary
'MKD' Macedonian denar
'MMK' Myanmar kyat
'MNT' Mongolian tögrög
'MOP' Macanese pataca
'MRU' Mauritanian ouguiya
'MUR' Mauritian rupee
'MVR' Maldivian rufiyaa
'MWK' Malawian kwacha
'MXN' Mexican peso
'MXV' Mexican Unidad de Inversion
'MYR' Malaysian ringgit
'MZN' Mozambican metical
'NAD' Namibian dollar
'NGN' Nigerian naira
'NIO' Nicaraguan córdoba
'NOK' Norwegian krone
'NPR' Nepalese rupee
'NZD' New Zealand dollar
'OMR' Omani rial
'PAB' Panamanian balboa
'PEN' Peruvian sol
'PGK' Papua New Guinean kina
'PHP' Philippine piso
'PKR' Pakistani rupee
'PLN' Polish złoty
'PYG' Paraguayan guaraní
'QAR' Qatari riyal
'RON' Romanian leu
'RSD' Serbian dinar
'RUB' Russian ruble
'RWF' Rwandan franc
'SAR' Saudi riyal
'SBD' Solomon Islands dollar
'SCR' Seychelles rupee
'SDG' Sudanese pound
'SEK' Swedish krona/kronor
'SGD' Singapore dollar
'SHP' Saint Helena pound
'SLL' Sierra Leonean leone
'SOS' Somali shilling
'SRD' Surinamese dollar
'SSP' South Sudanese pound
'STN' São Tomé and Príncipe dobra
'SVC' Salvadoran colón
'SYP' Syrian pound
'SZL' Swazi lilangeni
'THB' Thai baht
'TJS' Tajikistani somoni
'TMT' Turkmenistan manat
'TND' Tunisian dinar
'TOP' Tongan pa'anga
'TRY' Turkish lira
'TTD' Trinidad and Tobago dollar
'TWD' New Taiwan dollar
'TZS' Tanzanian shilling
'UAH' Ukrainian hryvnia
'UGX' Ugandan shilling
'USD' United States dollar
'USN' United States dollar
'UYI' Uruguay Peso en Unidades Indexadas
'UYU' Uruguayan peso
'UZS' Uzbekistan som
'VEF' Venezuelan bolívar
'VND' Vietnamese đồng
'VUV' Vanuatu vatu
'WST' Samoan tala
'XAF' CFA franc BEAC
'XAG' Silver
'XAU' Gold
'XBA' European Composite Unit
'XBB' European Monetary Unit
'XBC' European Unit of Account
'XBD' European Unit of Account
'XCD' East Caribbean dollar
'XDR' Special drawing rights
'XOF' CFA franc BCEAO
'XPD' Palladium
'XPF' CFP franc
'XPT' Platinum
'XSU' SUCRE
'XTS'
'XUA' ADB Unit of Account
'XXX'
'YER' Yemeni rial
'ZAR' South African rand
'ZMW' Zambian kwacha
'ZWL' Zimbabwean dollar

inactive
Whether this resource is marked as inactive.

Valid Values
'0' Active
'1' Inactive

frozen
Whether this resource is marked as frozen.

Valid Values
'0' Not frozen
'1' Frozen

Customers


Available Actions
Query
GET /customers or /customers/{id}
Update
PUT /customers/{id}
Delete
DELETE /customers/{id}
Create
POST /customers
Create  Customers

Create a Customer. A Customer is a record that is used to store data about a particular customer of a Merchant. You can use it to associate payment data to the Customer, or for use with other API features.


login
Required
The Login that owns this resource.

merchant
Optional
The Merchant associated with this Customer.

first
Optional
The first name associated with this Customer.

middle
Optional
The middle name associated with this Customer.

last
Optional
The last name associated with this Customer.

company
Optional
The name of the company associated with this Customer.

email
Optional
The email address of this Customer.

shippingFirst
Optional
The shipping first name associated with this Customer.

shippingMiddle
Optional
The shipping middle name associated with this Customer.

shippingLast
Optional
The shipping last name associated with this Customer.

shippingCompany
Optional
The shipping name of the company associated with this Customer.

shippingAddress1
Optional
The shipping first line of the address associated with this Customer. This field is stored as a text string and must be between 1 and 100 characters long.

shippingAddress2
Optional
The shipping second line of the address associated with this Customer. This field is stored as a text string and must be between 1 and 20 characters long.

shippingCity
Optional
The shipping name of the city in the address associated with this Customer. This field is stored as a text string and must be between 1 and 20 characters long.

shippingState
Optional
The shipping state associated with this Customer. If in the U.S. this is specified as the 2 character postal abbreviation for the state, if outside of the U.S. the full state name. This field is stored as a text string and must be between 2 and 100 characters long.

Valid Values
'AL'
'AK'
'AZ'
'AR'
'CA'
'CO'
'CT'
'DE'
'DC'
'FL'
'GA'
'HI'
'ID'
'IL'
'IN'
'IA'
'KS'
'KY'
'LA'
'ME'
'MD'
'MA'
'MI'
'MN'
'MS'
'MO'
'MT'
'NE'
'NV'
'NH'
'NJ'
'NM'
'NY'
'NC'
'ND'
'OH'
'OK'
'OR'
'PA'
'RI'
'SC'
'SD'
'TN'
'TX'
'UT'
'VT'
'VA'
'WA'
'WV'
'WI'
'WY'
'AS'
'GU'
'MP'
'PR'
'VI'

shippingZip
Optional
The shipping ZIP code in the address associated with this Customer. This field is stored as a text string and must be between 1 and 20 characters long.

shippingCountry
Optional
The shipping country associated with this Customer. Valid values for this field is the 3-letter ISO code for the country.

Valid Values
'ABW'
'AFG'
'AGO'
'AIA'
'ALA'
'ALB'
'AND'
'ARE'
'ARG'
'ARM'
'ASM'
'ATA'
'ATF'
'ATG'
'AUS'
'AUT'
'AZE'
'BDI'
'BEL'
'BEN'
'BES'
'BFA'
'BGD'
'BGR'
'BHR'
'BHS'
'BIH'
'BLM'
'BLR'
'BLZ'
'BMU'
'BOL'
'BRA'
'BRB'
'BRN'
'BTN'
'BVT'
'BWA'
'CAF'
'CAN'
'CCK'
'CHE'
'CHL'
'CHN'
'CIV'
'CMR'
'COD'
'COG'
'COK'
'COL'
'COM'
'CPV'
'CRI'
'CUB'
'CUW'
'CXR'
'CYM'
'CYP'
'CZE'
'DEU'
'DJI'
'DMA'
'DNK'
'DOM'
'DZA'
'ECU'
'EGY'
'ERI'
'ESH'
'ESP'
'EST'
'ETH'
'FIN'
'FJI'
'FLK'
'FRA'
'FRO'
'FSM'
'GAB'
'GBR'
'GEO'
'GGY'
'GHA'
'GIB'
'GIN'
'GLP'
'GMB'
'GNB'
'GNQ'
'GRC'
'GRD'
'GRL'
'GTM'
'GUF'
'GUM'
'GUY'
'HKG'
'HMD'
'HND'
'HRV'
'HTI'
'HUN'
'IDN'
'IMN'
'IND'
'IOT'
'IRL'
'IRN'
'IRQ'
'ISL'
'ISR'
'ITA'
'JAM'
'JEY'
'JOR'
'JPN'
'KAZ'
'KEN'
'KGZ'
'KHM'
'KIR'
'KNA'
'KOR'
'KWT'
'LAO'
'LBN'
'LBR'
'LBY'
'LCA'
'LIE'
'LKA'
'LSO'
'LTU'
'LUX'
'LVA'
'MAC'
'MAF'
'MAR'
'MCO'
'MDA'
'MDG'
'MDV'
'MEX'
'MHL'
'MKD'
'MLI'
'MLT'
'MMR'
'MNE'
'MNG'
'MNP'
'MOZ'
'MRT'
'MSR'
'MTQ'
'MUS'
'MWI'
'MYS'
'MYT'
'NAM'
'NCL'
'NER'
'NFK'
'NGA'
'NIC'
'NIU'
'NLD'
'NOR'
'NPL'
'NRU'
'NZL'
'OMN'
'PAK'
'PAN'
'PCN'
'PER'
'PHL'
'PLW'
'PNG'
'POL'
'PRI'
'PRK'
'PRT'
'PRY'
'PSE'
'PYF'
'QAT'
'REU'
'ROU'
'RUS'
'RWA'
'SAU'
'SDN'
'SEN'
'SGP'
'SGS'
'SHN'
'SJM'
'SLB'
'SLE'
'SLV'
'SMR'
'SOM'
'SPM'
'SRB'
'SSD'
'STP'
'SUR'
'SVK'
'SVN'
'SWE'
'SWZ'
'SXM'
'SYC'
'SYR'
'TCA'
'TCD'
'TGO'
'THA'
'TJK'
'TKL'
'TKM'
'TLS'
'TON'
'TTO'
'TUN'
'TUR'
'TUV'
'TWN'
'TZA'
'UGA'
'UKR'
'UMI'
'URY'
'USA'
'UZB'
'VAT'
'VCT'
'VEN'
'VGB'
'VIR'
'VNM'
'VUT'
'WLF'
'WSM'
'YEM'
'ZAF'
'ZMB'
'ZWE'

shippingPhone
Optional
The shipping phone number associated with this Transaction. This field is stored as a text string and must be between 10 and 15 characters long.

shippingFax
Optional
The shipping fax number associated with this Customer. This field is stored as a text string and must be between 10 and 15 characters long.

custom
Optional
Custom, free-form field for client-supplied text, must be between 0 and 1000 characters long.

address1
Optional
The first line of the address associated with this Customer. This field is stored as a text string and must be between 1 and 500 characters long.

address2
Optional
The second line of the address associated with this Customer. This field is stored as a text string and must be between 1 and 500 characters long.

city
Optional
The name of the city in the address associated with this Customer. This field is stored as a text string and must be between 1 and 500 characters long.

state
Optional
The state associated with this Customer. If in the U.S. this is specified as the 2 character postal abbreviation for the state, if outside of the U.S. the full state name. This field is stored as a text string and must be between 2 and 100 characters long.

Valid Values
'AL' Alabama
'AK' Alaska
'AZ' Arizona
'AR' Arkansas
'CA' California
'CO' Colorado
'CT' Connecticut
'DE' Delaware
'DC' District of Columbia
'FL' Florida
'GA' Georgia
'HI' Hawaii
'ID' Idaho
'IL' Illinois
'IN' Indiana
'IA' Iowa
'KS' Kansas
'KY' Kentucky
'LA' Louisiana
'ME' Maine
'MD' Maryland
'MA' Massachusetts
'MI' Michigan
'MN' Minnesota
'MS' Mississippi
'MO' Missouri
'MT' Montana
'NE' Nebraska
'NV' Nevada
'NH' New Hampshire
'NJ' New Jersey
'NM' New Mexico
'NY' New York
'NC' North Carolina
'ND' North Dakota
'OH' Ohio
'OK' Oklahoma
'OR' Oregon
'PA' Pennsylvania
'RI' Rhode Island
'SC' South Carolina
'SD' South Dakota
'TN' Tennessee
'TX' Texas
'UT' Utah
'VT' Vermont
'VA' Virginia
'WA' Washington
'WV' West Virginia
'WI' Wisconsin
'WY' Wyoming
'AS' American Samoa
'GU' Guam
'MP' Northern Mariana Islands
'PR' Puerto Rico
'VI' U.S. Virgin Islands

zip
Optional
The ZIP code in the address associated with this Customer. This field is stored as a text string and must be between 1 and 20 characters long.

country
Optional
The country associated with this Customer. Valid values for this field is the 3-letter ISO code for the country.

Valid Values
'ABW' Aruba
'AFG' Afghanistan
'AGO' Angola
'AIA' Anguilla
'ALA' Aland Islands
'ALB' Albania
'AND' Andorra
'ARE' United Arab Emirates
'ARG' Argentina
'ARM' Armenia
'ASM' American Samoa
'ATA' Antarctica
'ATF' French Southern Territories
'ATG' Antigua and Barbuda
'AUS' Australia
'AUT' Austria
'AZE' Azerbaijan
'BDI' Burundi
'BEL' Belgium
'BEN' Benin
'BES' Bonaire, Sint Eustatius and Saba
'BFA' Burkina Faso
'BGD' Bangladesh
'BGR' Bulgaria
'BHR' Bahrain
'BHS' Bahamas
'BIH' Bosnia and Herzegovina
'BLM' Saint Barthélemy
'BLR' Belarus
'BLZ' Belize
'BMU' Bermuda
'BOL' Bolivia, Plurinational State of
'BRA' Brazil
'BRB' Barbados
'BRN' Brunei Darussalam
'BTN' Bhutan
'BVT' Bouvet Island
'BWA' Botswana
'CAF' Central African Republic
'CAN' Canada
'CCK' Cocos (Keeling) Islands
'CHE' Switzerland
'CHL' Chile
'CHN' China
'CIV' Côte d’Ivoire
'CMR' Cameroon
'COD' Congo, the Democratic Republic of the
'COG' Congo
'COK' Cook Islands
'COL' Colombia
'COM' Comoros
'CPV' Cape Verde
'CRI' Costa Rica
'CUB' Cuba
'CUW' Curaçao
'CXR' Christmas Island
'CYM' Cayman Islands
'CYP' Cyprus
'CZE' Czech Republic
'DEU' Germany
'DJI' Djibouti
'DMA' Dominica
'DNK' Denmark
'DOM' Dominican Republic
'DZA' Algeria
'ECU' Ecuador
'EGY' Egypt
'ERI' Eritrea
'ESH' Western Sahara
'ESP' Spain
'EST' Estonia
'ETH' Ethiopia
'FIN' Finland
'FJI' Fiji
'FLK' Falkland Islands (Malvinas)
'FRA' France
'FRO' Faroe Islands
'FSM' Micronesia, Federated States of
'GAB' Gabon
'GBR' United Kingdom
'GEO' Georgia
'GGY' Guernsey
'GHA' Ghana
'GIB' Gibraltar
'GIN' Guinea
'GLP' Guadeloupe
'GMB' Gambia
'GNB' Guinea-Bissau
'GNQ' Equatorial Guinea
'GRC' Greece
'GRD' Grenada
'GRL' Greenland
'GTM' Guatemala
'GUF' French Guiana
'GUM' Guam
'GUY' Guyana
'HKG' Hong Kong
'HMD' Heard Island and McDonald Islands
'HND' Honduras
'HRV' Croatia
'HTI' Haiti
'HUN' Hungary
'IDN' Indonesia
'IMN' Isle of Man
'IND' India
'IOT' British Indian Ocean Territory
'IRL' Ireland
'IRN' Iran, Islamic Republic of
'IRQ' Iraq
'ISL' Iceland
'ISR' Israel
'ITA' Italy
'JAM' Jamaica
'JEY' Jersey
'JOR' Jordan
'JPN' Japan
'KAZ' Kazakhstan
'KEN' Kenya
'KGZ' Kyrgyzstan
'KHM' Cambodia
'KIR' Kiribati
'KNA' Saint Kitts and Nevis
'KOR' Korea, Republic of
'KWT' Kuwait
'LAO' Lao People's Democratic Republic
'LBN' Lebanon
'LBR' Liberia
'LBY' Libya
'LCA' Saint Lucia
'LIE' Liechtenstein
'LKA' Sri Lanka
'LSO' Lesotho
'LTU' Lithuania
'LUX' Luxembourg
'LVA' Latvia
'MAC' Macao
'MAF' Saint Martin (French part)
'MAR' Morocco
'MCO' Monaco
'MDA' Moldova, Republic of
'MDG' Madagascar
'MDV' Maldives
'MEX' Mexico
'MHL' Marshall Islands
'MKD' Macedonia, the former Yugoslav Republic of
'MLI' Mali
'MLT' Malta
'MMR' Myanmar
'MNE' Montenegro
'MNG' Mongolia
'MNP' Northern Mariana Islands
'MOZ' Mozambique
'MRT' Mauritania
'MSR' Montserrat
'MTQ' Martinique
'MUS' Mauritius
'MWI' Malawi
'MYS' Malaysia
'MYT' Mayotte
'NAM' Namibia
'NCL' New Caledonia
'NER' Niger
'NFK' Norfolk Island
'NGA' Nigeria
'NIC' Nicaragua
'NIU' Niue
'NLD' Netherlands
'NOR' Norway
'NPL' Nepal
'NRU' Nauru
'NZL' New Zealand
'OMN' Oman
'PAK' Pakistan
'PAN' Panama
'PCN' Pitcairn
'PER' Peru
'PHL' Philippines
'PLW' Palau
'PNG' Papua New Guinea
'POL' Poland
'PRI' Puerto Rico
'PRK' Korea, Democratic People's Republic of
'PRT' Portugal
'PRY' Paraguay
'PSE' Palestine, State of
'PYF' French Polynesia
'QAT' Qatar
'REU' Réunion
'ROU' Romania
'RUS' Russian Federation
'RWA' Rwanda
'SAU' Saudi Arabia
'SDN' Sudan
'SEN' Senegal
'SGP' Singapore
'SGS' South Georgia and the South Sandwich Islands
'SHN' Saint Helena, Ascension and Tristan da Cunha
'SJM' Svalbard and Jan Mayen
'SLB' Solomon Islands
'SLE' Sierra Leone
'SLV' El Salvador
'SMR' San Marino
'SOM' Somalia
'SPM' Saint Pierre and Miquelon
'SRB' Serbia
'SSD' South Sudan
'STP' Sao Tome and Principe
'SUR' Suriname
'SVK' Slovakia
'SVN' Slovenia
'SWE' Sweden
'SWZ' Swaziland
'SXM' Sint Maarten (Dutch part)
'SYC' Seychelles
'SYR' Syrian Arab Republic
'TCA' Turks and Caicos Islands
'TCD' Chad
'TGO' Togo
'THA' Thailand
'TJK' Tajikistan
'TKL' Tokelau
'TKM' Turkmenistan
'TLS' Timor-Leste
'TON' Tonga
'TTO' Trinidad and Tobago
'TUN' Tunisia
'TUR' Turkey
'TUV' Tuvalu
'TWN' Taiwan, Province of China
'TZA' Tanzania, United Republic of
'UGA' Uganda
'UKR' Ukraine
'UMI' United States Minor Outlying Islands
'URY' Uruguay
'USA' United States
'UZB' Uzbekistan
'VAT' Holy See (Vatican City State)
'VCT' Saint Vincent and the Grenadines
'VEN' Venezuela, Bolivarian Republic of
'VGB' Virgin Islands, British
'VIR' Virgin Islands, U.S.
'VNM' Viet Nam
'VUT' Vanuatu
'WLF' Wallis and Futuna
'WSM' Samoa
'YEM' Yemen
'ZAF' South Africa
'ZMB' Zambia
'ZWE' Zimbabwe

phone
Optional
The phone number associated with this Transaction. This field is stored as a text string and must be between 10 and 15 characters long.

fax
Optional
The fax number associated with this Customer. This field is stored as a text string and must be between 10 and 15 characters long.

inactive
Required
Whether this resource is marked as inactive.

Valid Values
'0' Active
'1' Inactive

frozen
Required
Whether this resource is marked as frozen.

Valid Values
'0' Not frozen
'1' Frozen

Example request


curl

https://api.payrix.com/customers \


-H APIKEY: nsub8et5IuJ7JP3lvsWrQbK \
-d first="Robert" \
-d last="Johnson" \
-d email="robert.johnson@example.com"



Example request

\Payrix\Utilities\Config::setApiKey("nsub8et5IuJ7JP3lvsWrQbK");

$object = new \Payrix\customers(

array (

'first' => "Robert",

'last' => "Johnson",

'email' => "robert.johnson@example.com"

)

);


try {

}

catch (\Payrix\Exceptions\Base $e) {

// Handle exceptions

}

Example request

using System;

using Payrix;

using Payrix.Utilities;

Config.ApiKey = "nsub8et5IuJ7JP3lvsWrQbK";

var customers = new Customers

{

First = "Robert",

Last = "Johnson",

Email = "robert.johnson@example.com"

}


var success = customers.Create();

Example request

config.api_key = "nsub8et5IuJ7JP3lvsWrQbK"

object = Payrix.Resource.Customers.new( params {

'first': "Robert",

'last': "Johnson",

'email': "robert.johnson@example.com"

})


begin

rescue

# Handle errors

end

Update  Customers

Update a Customer. A Customer is a record that is used to store data about a particular customer of a Merchant. You can use it to associate payment data to the Customer, or for use with other API features.


login
Required
The Login that owns this resource.

merchant
Optional
The Merchant associated with this Customer.

first
Optional
The first name associated with this Customer.

middle
Optional
The middle name associated with this Customer.

last
Optional
The last name associated with this Customer.

company
Optional
The name of the company associated with this Customer.

email
Optional
The email address of this Customer.

shippingFirst
Optional
The shipping first name associated with this Customer.

shippingMiddle
Optional
The shipping middle name associated with this Customer.

shippingLast
Optional
The shipping last name associated with this Customer.

shippingCompany
Optional
The shipping name of the company associated with this Customer.

shippingAddress1
Optional
The shipping first line of the address associated with this Customer. This field is stored as a text string and must be between 1 and 100 characters long.

shippingAddress2
Optional
The shipping second line of the address associated with this Customer. This field is stored as a text string and must be between 1 and 20 characters long.

shippingCity
Optional
The shipping name of the city in the address associated with this Customer. This field is stored as a text string and must be between 1 and 20 characters long.

shippingState
Optional
The shipping state associated with this Customer. If in the U.S. this is specified as the 2 character postal abbreviation for the state, if outside of the U.S. the full state name. This field is stored as a text string and must be between 2 and 100 characters long.

Valid Values
'AL'
'AK'
'AZ'
'AR'
'CA'
'CO'
'CT'
'DE'
'DC'
'FL'
'GA'
'HI'
'ID'
'IL'
'IN'
'IA'
'KS'
'KY'
'LA'
'ME'
'MD'
'MA'
'MI'
'MN'
'MS'
'MO'
'MT'
'NE'
'NV'
'NH'
'NJ'
'NM'
'NY'
'NC'
'ND'
'OH'
'OK'
'OR'
'PA'
'RI'
'SC'
'SD'
'TN'
'TX'
'UT'
'VT'
'VA'
'WA'
'WV'
'WI'
'WY'
'AS'
'GU'
'MP'
'PR'
'VI'

shippingZip
Optional
The shipping ZIP code in the address associated with this Customer. This field is stored as a text string and must be between 1 and 20 characters long.

shippingCountry
Optional
The shipping country associated with this Customer. Valid values for this field is the 3-letter ISO code for the country.

Valid Values
'ABW'
'AFG'
'AGO'
'AIA'
'ALA'
'ALB'
'AND'
'ARE'
'ARG'
'ARM'
'ASM'
'ATA'
'ATF'
'ATG'
'AUS'
'AUT'
'AZE'
'BDI'
'BEL'
'BEN'
'BES'
'BFA'
'BGD'
'BGR'
'BHR'
'BHS'
'BIH'
'BLM'
'BLR'
'BLZ'
'BMU'
'BOL'
'BRA'
'BRB'
'BRN'
'BTN'
'BVT'
'BWA'
'CAF'
'CAN'
'CCK'
'CHE'
'CHL'
'CHN'
'CIV'
'CMR'
'COD'
'COG'
'COK'
'COL'
'COM'
'CPV'
'CRI'
'CUB'
'CUW'
'CXR'
'CYM'
'CYP'
'CZE'
'DEU'
'DJI'
'DMA'
'DNK'
'DOM'
'DZA'
'ECU'
'EGY'
'ERI'
'ESH'
'ESP'
'EST'
'ETH'
'FIN'
'FJI'
'FLK'
'FRA'
'FRO'
'FSM'
'GAB'
'GBR'
'GEO'
'GGY'
'GHA'
'GIB'
'GIN'
'GLP'
'GMB'
'GNB'
'GNQ'
'GRC'
'GRD'
'GRL'
'GTM'
'GUF'
'GUM'
'GUY'
'HKG'
'HMD'
'HND'
'HRV'
'HTI'
'HUN'
'IDN'
'IMN'
'IND'
'IOT'
'IRL'
'IRN'
'IRQ'
'ISL'
'ISR'
'ITA'
'JAM'
'JEY'
'JOR'
'JPN'
'KAZ'
'KEN'
'KGZ'
'KHM'
'KIR'
'KNA'
'KOR'
'KWT'
'LAO'
'LBN'
'LBR'
'LBY'
'LCA'
'LIE'
'LKA'
'LSO'
'LTU'
'LUX'
'LVA'
'MAC'
'MAF'
'MAR'
'MCO'
'MDA'
'MDG'
'MDV'
'MEX'
'MHL'
'MKD'
'MLI'
'MLT'
'MMR'
'MNE'
'MNG'
'MNP'
'MOZ'
'MRT'
'MSR'
'MTQ'
'MUS'
'MWI'
'MYS'
'MYT'
'NAM'
'NCL'
'NER'
'NFK'
'NGA'
'NIC'
'NIU'
'NLD'
'NOR'
'NPL'
'NRU'
'NZL'
'OMN'
'PAK'
'PAN'
'PCN'
'PER'
'PHL'
'PLW'
'PNG'
'POL'
'PRI'
'PRK'
'PRT'
'PRY'
'PSE'
'PYF'
'QAT'
'REU'
'ROU'
'RUS'
'RWA'
'SAU'
'SDN'
'SEN'
'SGP'
'SGS'
'SHN'
'SJM'
'SLB'
'SLE'
'SLV'
'SMR'
'SOM'
'SPM'
'SRB'
'SSD'
'STP'
'SUR'
'SVK'
'SVN'
'SWE'
'SWZ'
'SXM'
'SYC'
'SYR'
'TCA'
'TCD'
'TGO'
'THA'
'TJK'
'TKL'
'TKM'
'TLS'
'TON'
'TTO'
'TUN'
'TUR'
'TUV'
'TWN'
'TZA'
'UGA'
'UKR'
'UMI'
'URY'
'USA'
'UZB'
'VAT'
'VCT'
'VEN'
'VGB'
'VIR'
'VNM'
'VUT'
'WLF'
'WSM'
'YEM'
'ZAF'
'ZMB'
'ZWE'

shippingPhone
Optional
The shipping phone number associated with this Transaction. This field is stored as a text string and must be between 10 and 15 characters long.

shippingFax
Optional
The shipping fax number associated with this Customer. This field is stored as a text string and must be between 10 and 15 characters long.

custom
Optional
Custom, free-form field for client-supplied text, must be between 0 and 1000 characters long.

address1
Optional
The first line of the address associated with this Customer. This field is stored as a text string and must be between 1 and 500 characters long.

address2
Optional
The second line of the address associated with this Customer. This field is stored as a text string and must be between 1 and 500 characters long.

city
Optional
The name of the city in the address associated with this Customer. This field is stored as a text string and must be between 1 and 500 characters long.

state
Optional
The state associated with this Customer. If in the U.S. this is specified as the 2 character postal abbreviation for the state, if outside of the U.S. the full state name. This field is stored as a text string and must be between 2 and 100 characters long.

Valid Values
'AL' Alabama
'AK' Alaska
'AZ' Arizona
'AR' Arkansas
'CA' California
'CO' Colorado
'CT' Connecticut
'DE' Delaware
'DC' District of Columbia
'FL' Florida
'GA' Georgia
'HI' Hawaii
'ID' Idaho
'IL' Illinois
'IN' Indiana
'IA' Iowa
'KS' Kansas
'KY' Kentucky
'LA' Louisiana
'ME' Maine
'MD' Maryland
'MA' Massachusetts
'MI' Michigan
'MN' Minnesota
'MS' Mississippi
'MO' Missouri
'MT' Montana
'NE' Nebraska
'NV' Nevada
'NH' New Hampshire
'NJ' New Jersey
'NM' New Mexico
'NY' New York
'NC' North Carolina
'ND' North Dakota
'OH' Ohio
'OK' Oklahoma
'OR' Oregon
'PA' Pennsylvania
'RI' Rhode Island
'SC' South Carolina
'SD' South Dakota
'TN' Tennessee
'TX' Texas
'UT' Utah
'VT' Vermont
'VA' Virginia
'WA' Washington
'WV' West Virginia
'WI' Wisconsin
'WY' Wyoming
'AS' American Samoa
'GU' Guam
'MP' Northern Mariana Islands
'PR' Puerto Rico
'VI' U.S. Virgin Islands

zip
Optional
The ZIP code in the address associated with this Customer. This field is stored as a text string and must be between 1 and 20 characters long.

country
Optional
The country associated with this Customer. Valid values for this field is the 3-letter ISO code for the country.

Valid Values
'ABW' Aruba
'AFG' Afghanistan
'AGO' Angola
'AIA' Anguilla
'ALA' Aland Islands
'ALB' Albania
'AND' Andorra
'ARE' United Arab Emirates
'ARG' Argentina
'ARM' Armenia
'ASM' American Samoa
'ATA' Antarctica
'ATF' French Southern Territories
'ATG' Antigua and Barbuda
'AUS' Australia
'AUT' Austria
'AZE' Azerbaijan
'BDI' Burundi
'BEL' Belgium
'BEN' Benin
'BES' Bonaire, Sint Eustatius and Saba
'BFA' Burkina Faso
'BGD' Bangladesh
'BGR' Bulgaria
'BHR' Bahrain
'BHS' Bahamas
'BIH' Bosnia and Herzegovina
'BLM' Saint Barthélemy
'BLR' Belarus
'BLZ' Belize
'BMU' Bermuda
'BOL' Bolivia, Plurinational State of
'BRA' Brazil
'BRB' Barbados
'BRN' Brunei Darussalam
'BTN' Bhutan
'BVT' Bouvet Island
'BWA' Botswana
'CAF' Central African Republic
'CAN' Canada
'CCK' Cocos (Keeling) Islands
'CHE' Switzerland
'CHL' Chile
'CHN' China
'CIV' Côte d’Ivoire
'CMR' Cameroon
'COD' Congo, the Democratic Republic of the
'COG' Congo
'COK' Cook Islands
'COL' Colombia
'COM' Comoros
'CPV' Cape Verde
'CRI' Costa Rica
'CUB' Cuba
'CUW' Curaçao
'CXR' Christmas Island
'CYM' Cayman Islands
'CYP' Cyprus
'CZE' Czech Republic
'DEU' Germany
'DJI' Djibouti
'DMA' Dominica
'DNK' Denmark
'DOM' Dominican Republic
'DZA' Algeria
'ECU' Ecuador
'EGY' Egypt
'ERI' Eritrea
'ESH' Western Sahara
'ESP' Spain
'EST' Estonia
'ETH' Ethiopia
'FIN' Finland
'FJI' Fiji
'FLK' Falkland Islands (Malvinas)
'FRA' France
'FRO' Faroe Islands
'FSM' Micronesia, Federated States of
'GAB' Gabon
'GBR' United Kingdom
'GEO' Georgia
'GGY' Guernsey
'GHA' Ghana
'GIB' Gibraltar
'GIN' Guinea
'GLP' Guadeloupe
'GMB' Gambia
'GNB' Guinea-Bissau
'GNQ' Equatorial Guinea
'GRC' Greece
'GRD' Grenada
'GRL' Greenland
'GTM' Guatemala
'GUF' French Guiana
'GUM' Guam
'GUY' Guyana
'HKG' Hong Kong
'HMD' Heard Island and McDonald Islands
'HND' Honduras
'HRV' Croatia
'HTI' Haiti
'HUN' Hungary
'IDN' Indonesia
'IMN' Isle of Man
'IND' India
'IOT' British Indian Ocean Territory
'IRL' Ireland
'IRN' Iran, Islamic Republic of
'IRQ' Iraq
'ISL' Iceland
'ISR' Israel
'ITA' Italy
'JAM' Jamaica
'JEY' Jersey
'JOR' Jordan
'JPN' Japan
'KAZ' Kazakhstan
'KEN' Kenya
'KGZ' Kyrgyzstan
'KHM' Cambodia
'KIR' Kiribati
'KNA' Saint Kitts and Nevis
'KOR' Korea, Republic of
'KWT' Kuwait
'LAO' Lao People's Democratic Republic
'LBN' Lebanon
'LBR' Liberia
'LBY' Libya
'LCA' Saint Lucia
'LIE' Liechtenstein
'LKA' Sri Lanka
'LSO' Lesotho
'LTU' Lithuania
'LUX' Luxembourg
'LVA' Latvia
'MAC' Macao
'MAF' Saint Martin (French part)
'MAR' Morocco
'MCO' Monaco
'MDA' Moldova, Republic of
'MDG' Madagascar
'MDV' Maldives
'MEX' Mexico
'MHL' Marshall Islands
'MKD' Macedonia, the former Yugoslav Republic of
'MLI' Mali
'MLT' Malta
'MMR' Myanmar
'MNE' Montenegro
'MNG' Mongolia
'MNP' Northern Mariana Islands
'MOZ' Mozambique
'MRT' Mauritania
'MSR' Montserrat
'MTQ' Martinique
'MUS' Mauritius
'MWI' Malawi
'MYS' Malaysia
'MYT' Mayotte
'NAM' Namibia
'NCL' New Caledonia
'NER' Niger
'NFK' Norfolk Island
'NGA' Nigeria
'NIC' Nicaragua
'NIU' Niue
'NLD' Netherlands
'NOR' Norway
'NPL' Nepal
'NRU' Nauru
'NZL' New Zealand
'OMN' Oman
'PAK' Pakistan
'PAN' Panama
'PCN' Pitcairn
'PER' Peru
'PHL' Philippines
'PLW' Palau
'PNG' Papua New Guinea
'POL' Poland
'PRI' Puerto Rico
'PRK' Korea, Democratic People's Republic of
'PRT' Portugal
'PRY' Paraguay
'PSE' Palestine, State of
'PYF' French Polynesia
'QAT' Qatar
'REU' Réunion
'ROU' Romania
'RUS' Russian Federation
'RWA' Rwanda
'SAU' Saudi Arabia
'SDN' Sudan
'SEN' Senegal
'SGP' Singapore
'SGS' South Georgia and the South Sandwich Islands
'SHN' Saint Helena, Ascension and Tristan da Cunha
'SJM' Svalbard and Jan Mayen
'SLB' Solomon Islands
'SLE' Sierra Leone
'SLV' El Salvador
'SMR' San Marino
'SOM' Somalia
'SPM' Saint Pierre and Miquelon
'SRB' Serbia
'SSD' South Sudan
'STP' Sao Tome and Principe
'SUR' Suriname
'SVK' Slovakia
'SVN' Slovenia
'SWE' Sweden
'SWZ' Swaziland
'SXM' Sint Maarten (Dutch part)
'SYC' Seychelles
'SYR' Syrian Arab Republic
'TCA' Turks and Caicos Islands
'TCD' Chad
'TGO' Togo
'THA' Thailand
'TJK' Tajikistan
'TKL' Tokelau
'TKM' Turkmenistan
'TLS' Timor-Leste
'TON' Tonga
'TTO' Trinidad and Tobago
'TUN' Tunisia
'TUR' Turkey
'TUV' Tuvalu
'TWN' Taiwan, Province of China
'TZA' Tanzania, United Republic of
'UGA' Uganda
'UKR' Ukraine
'UMI' United States Minor Outlying Islands
'URY' Uruguay
'USA' United States
'UZB' Uzbekistan
'VAT' Holy See (Vatican City State)
'VCT' Saint Vincent and the Grenadines
'VEN' Venezuela, Bolivarian Republic of
'VGB' Virgin Islands, British
'VIR' Virgin Islands, U.S.
'VNM' Viet Nam
'VUT' Vanuatu
'WLF' Wallis and Futuna
'WSM' Samoa
'YEM' Yemen
'ZAF' South Africa
'ZMB' Zambia
'ZWE' Zimbabwe

phone
Optional
The phone number associated with this Transaction. This field is stored as a text string and must be between 10 and 15 characters long.

fax
Optional
The fax number associated with this Customer. This field is stored as a text string and must be between 10 and 15 characters long.

inactive
Required
Whether this resource is marked as inactive.

Valid Values
'0' Active
'1' Inactive

frozen
Required
Whether this resource is marked as frozen.

Valid Values
'0' Not frozen
'1' Frozen

Example request


curl

https://api.payrix.com/customers/p1_cus_5a1ef5e55656e2484591e84 \


-H APIKEY: nsub8et5IuJ7JP3lvsWrQbK \
-d merchant="p1_mer_5a1ef5e55656a739a85da21"



Example request

\Payrix\Utilities\Config::setApiKey("nsub8et5IuJ7JP3lvsWrQbK");

$object = new \Payrix\customers(

array (

'id' => "p1_cus_5a1ef5e55656e2484591e84",

'merchant' => "p1_mer_5a1ef5e55656a739a85da21"

)

);


try {

}

catch (\Payrix\Exceptions\Base $e) {

// Handle exceptions

}

Example request

using System;

using Payrix;

using Payrix.Utilities;

Config.ApiKey = "nsub8et5IuJ7JP3lvsWrQbK";

var customers = new Customers

{

Id = "p1_cus_5a1ef5e55656e2484591e84",

Merchant = "p1_mer_5a1ef5e55656a739a85da21"

}


var success = customers.Update();

Example request

config.api_key = "nsub8et5IuJ7JP3lvsWrQbK"

object = Payrix.Resource.Customers.new( params {

'id': "p1_cus_5a1ef5e55656e2484591e84",

'merchant': "p1_mer_5a1ef5e55656a739a85da21"

})


begin

rescue

# Handle errors

end

Customers Response

id
The ID of this resource.

created
The date and time at which this resource was created.

modified
The date and time at which this resource was modified.

creator
The identifier of the Login that created this resource.

modifier
The identifier of the Login that last modified this resource.

login
The Login that owns this resource.

merchant
The Merchant associated with this Customer.

first
The first name associated with this Customer.

middle
The middle name associated with this Customer.

last
The last name associated with this Customer.

company
The name of the company associated with this Customer.

email
The email address of this Customer.

fax
The fax number associated with this Customer. This field is stored as a text string and must be between 10 and 15 characters long.

phone
The phone number associated with this Transaction. This field is stored as a text string and must be between 10 and 15 characters long.

country
The country associated with this Customer. Valid values for this field is the 3-letter ISO code for the country.

Valid Values
'ABW' Aruba
'AFG' Afghanistan
'AGO' Angola
'AIA' Anguilla
'ALA' Aland Islands
'ALB' Albania
'AND' Andorra
'ARE' United Arab Emirates
'ARG' Argentina
'ARM' Armenia
'ASM' American Samoa
'ATA' Antarctica
'ATF' French Southern Territories
'ATG' Antigua and Barbuda
'AUS' Australia
'AUT' Austria
'AZE' Azerbaijan
'BDI' Burundi
'BEL' Belgium
'BEN' Benin
'BES' Bonaire, Sint Eustatius and Saba
'BFA' Burkina Faso
'BGD' Bangladesh
'BGR' Bulgaria
'BHR' Bahrain
'BHS' Bahamas
'BIH' Bosnia and Herzegovina
'BLM' Saint Barthélemy
'BLR' Belarus
'BLZ' Belize
'BMU' Bermuda
'BOL' Bolivia, Plurinational State of
'BRA' Brazil
'BRB' Barbados
'BRN' Brunei Darussalam
'BTN' Bhutan
'BVT' Bouvet Island
'BWA' Botswana
'CAF' Central African Republic
'CAN' Canada
'CCK' Cocos (Keeling) Islands
'CHE' Switzerland
'CHL' Chile
'CHN' China
'CIV' Côte d’Ivoire
'CMR' Cameroon
'COD' Congo, the Democratic Republic of the
'COG' Congo
'COK' Cook Islands
'COL' Colombia
'COM' Comoros
'CPV' Cape Verde
'CRI' Costa Rica
'CUB' Cuba
'CUW' Curaçao
'CXR' Christmas Island
'CYM' Cayman Islands
'CYP' Cyprus
'CZE' Czech Republic
'DEU' Germany
'DJI' Djibouti
'DMA' Dominica
'DNK' Denmark
'DOM' Dominican Republic
'DZA' Algeria
'ECU' Ecuador
'EGY' Egypt
'ERI' Eritrea
'ESH' Western Sahara
'ESP' Spain
'EST' Estonia
'ETH' Ethiopia
'FIN' Finland
'FJI' Fiji
'FLK' Falkland Islands (Malvinas)
'FRA' France
'FRO' Faroe Islands
'FSM' Micronesia, Federated States of
'GAB' Gabon
'GBR' United Kingdom
'GEO' Georgia
'GGY' Guernsey
'GHA' Ghana
'GIB' Gibraltar
'GIN' Guinea
'GLP' Guadeloupe
'GMB' Gambia
'GNB' Guinea-Bissau
'GNQ' Equatorial Guinea
'GRC' Greece
'GRD' Grenada
'GRL' Greenland
'GTM' Guatemala
'GUF' French Guiana
'GUM' Guam
'GUY' Guyana
'HKG' Hong Kong
'HMD' Heard Island and McDonald Islands
'HND' Honduras
'HRV' Croatia
'HTI' Haiti
'HUN' Hungary
'IDN' Indonesia
'IMN' Isle of Man
'IND' India
'IOT' British Indian Ocean Territory
'IRL' Ireland
'IRN' Iran, Islamic Republic of
'IRQ' Iraq
'ISL' Iceland
'ISR' Israel
'ITA' Italy
'JAM' Jamaica
'JEY' Jersey
'JOR' Jordan
'JPN' Japan
'KAZ' Kazakhstan
'KEN' Kenya
'KGZ' Kyrgyzstan
'KHM' Cambodia
'KIR' Kiribati
'KNA' Saint Kitts and Nevis
'KOR' Korea, Republic of
'KWT' Kuwait
'LAO' Lao People's Democratic Republic
'LBN' Lebanon
'LBR' Liberia
'LBY' Libya
'LCA' Saint Lucia
'LIE' Liechtenstein
'LKA' Sri Lanka
'LSO' Lesotho
'LTU' Lithuania
'LUX' Luxembourg
'LVA' Latvia
'MAC' Macao
'MAF' Saint Martin (French part)
'MAR' Morocco
'MCO' Monaco
'MDA' Moldova, Republic of
'MDG' Madagascar
'MDV' Maldives
'MEX' Mexico
'MHL' Marshall Islands
'MKD' Macedonia, the former Yugoslav Republic of
'MLI' Mali
'MLT' Malta
'MMR' Myanmar
'MNE' Montenegro
'MNG' Mongolia
'MNP' Northern Mariana Islands
'MOZ' Mozambique
'MRT' Mauritania
'MSR' Montserrat
'MTQ' Martinique
'MUS' Mauritius
'MWI' Malawi
'MYS' Malaysia
'MYT' Mayotte
'NAM' Namibia
'NCL' New Caledonia
'NER' Niger
'NFK' Norfolk Island
'NGA' Nigeria
'NIC' Nicaragua
'NIU' Niue
'NLD' Netherlands
'NOR' Norway
'NPL' Nepal
'NRU' Nauru
'NZL' New Zealand
'OMN' Oman
'PAK' Pakistan
'PAN' Panama
'PCN' Pitcairn
'PER' Peru
'PHL' Philippines
'PLW' Palau
'PNG' Papua New Guinea
'POL' Poland
'PRI' Puerto Rico
'PRK' Korea, Democratic People's Republic of
'PRT' Portugal
'PRY' Paraguay
'PSE' Palestine, State of
'PYF' French Polynesia
'QAT' Qatar
'REU' Réunion
'ROU' Romania
'RUS' Russian Federation
'RWA' Rwanda
'SAU' Saudi Arabia
'SDN' Sudan
'SEN' Senegal
'SGP' Singapore
'SGS' South Georgia and the South Sandwich Islands