POST v1/paymentMethods
Documentation for 'Post'.
Request Information
Parameters
Name | Description | Additional information |
---|---|---|
creditCard | Documentation for 'creditCard'. |
Define this parameter in the request body. |
Request body formats
application/json, text/json
Sample:
Click to beautify!
{ "cardNumber": "sample string 1", "expirationMonth": 2, "expirationYear": 3, "cvv": "sample string 4", "firstName": "sample string 5", "lastName": "sample string 6", "address1": "sample string 7", "address2": "sample string 8", "city": "sample string 9", "stateId": 1, "countryId": 1, "postalZip": "sample string 10", "paymentCollectOptions": { "collectionAmount": 1.0, "payPendingCharges": true, "payBalanceOwing": true }, "email": "sample string 11", "makeDefault": true, "riskToken": "sample string 13", "clientIp": "sample string 14", "businessTaxId": "sample string 15", "customerId": 16, "source": "sample string 17" }
application/xml, text/xml
Sample:
Click to beautify!
<CreditCard xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.Dto.Post"> <CustomerId>16</CustomerId> <Source>sample string 17</Source> <Address1>sample string 7</Address1> <Address2>sample string 8</Address2> <BusinessTaxId>sample string 15</BusinessTaxId> <City>sample string 9</City> <ClientIp>sample string 14</ClientIp> <CountryId>1</CountryId> <Email>sample string 11</Email> <FirstName>sample string 5</FirstName> <LastName>sample string 6</LastName> <MakeDefault>true</MakeDefault> <PaymentCollectOptions> <CollectionAmount>1</CollectionAmount> <PayBalanceOwing>true</PayBalanceOwing> <PayPendingCharges>true</PayPendingCharges> </PaymentCollectOptions> <PostalZip>sample string 10</PostalZip> <RiskToken>sample string 13</RiskToken> <StateId>1</StateId> <CardNumber>sample string 1</CardNumber> <Cvv>sample string 4</Cvv> <ExpirationMonth>2</ExpirationMonth> <ExpirationYear>3</ExpirationYear> </CreditCard>
application/x-www-form-urlencoded
Sample:
Click to beautify!
Sample not available.
Response Information
Response body formats
application/json, text/json
Sample:
Click to beautify!
{ "maskedCardNumber": "sample string 1", "cardType": "sample string 2", "expirationMonth": 3, "expirationYear": 4, "isDebit": true, "isGooglePay": true, "customerId": 5, "firstName": "sample string 6", "lastName": "sample string 7", "address1": "sample string 8", "address2": "sample string 9", "countryId": 1, "country": "sample string 10", "stateId": 1, "state": "sample string 11", "city": "sample string 12", "postalZip": "sample string 13", "isDefault": true, "isParent": true, "externalCustomerId": "sample string 16", "externalCardId": "sample string 17", "storedInFusebillVault": true, "email": "sample string 19", "modifiedDate": "2024-05-03T04:20:58.4217328+00:00", "originalPaymentMethodId": 1, "isUsedForBillingPeriodOverride": true, "businessTaxId": "sample string 21", "storedInStax": true, "paymentMethodType": "sample string 23", "sharing": true, "descendantOverrides": [ { "id": 1, "customerId": 2, "sharing": true }, { "id": 1, "customerId": 2, "sharing": true }, { "id": 1, "customerId": 2, "sharing": true } ], "status": "sample string 24", "repeatFailureCount": 25, "id": 26, "uri": "sample string 27" }
application/xml, text/xml
Sample:
Click to beautify!
<CreditCard xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.Dto.Get"> <Id>26</Id> <Uri>sample string 27</Uri> <Address1>sample string 8</Address1> <Address2>sample string 9</Address2> <BusinessTaxId>sample string 21</BusinessTaxId> <City>sample string 12</City> <Country>sample string 10</Country> <CountryId>1</CountryId> <CustomerId>5</CustomerId> <DescendantOverrides> <PaymentMethodSharing> <CustomerId>2</CustomerId> <Id>1</Id> <Sharing>true</Sharing> </PaymentMethodSharing> <PaymentMethodSharing> <CustomerId>2</CustomerId> <Id>1</Id> <Sharing>true</Sharing> </PaymentMethodSharing> <PaymentMethodSharing> <CustomerId>2</CustomerId> <Id>1</Id> <Sharing>true</Sharing> </PaymentMethodSharing> </DescendantOverrides> <Email>sample string 19</Email> <ExternalCardId>sample string 17</ExternalCardId> <ExternalCustomerId>sample string 16</ExternalCustomerId> <FirstName>sample string 6</FirstName> <IsDefault>true</IsDefault> <IsParent>true</IsParent> <IsUsedForBillingPeriodOverride>true</IsUsedForBillingPeriodOverride> <LastName>sample string 7</LastName> <ModifiedDate>2024-05-03T04:20:58.4217328+00:00</ModifiedDate> <OriginalPaymentMethodId>1</OriginalPaymentMethodId> <PaymentMethodType>sample string 23</PaymentMethodType> <PostalZip>sample string 13</PostalZip> <RepeatFailureCount>25</RepeatFailureCount> <Sharing>true</Sharing> <State>sample string 11</State> <StateId>1</StateId> <Status>sample string 24</Status> <StoredInFusebillVault>true</StoredInFusebillVault> <StoredInStax>true</StoredInStax> <CardType>sample string 2</CardType> <ExpirationMonth>3</ExpirationMonth> <ExpirationYear>4</ExpirationYear> <IsDebit>true</IsDebit> <IsGooglePay>true</IsGooglePay> <MaskedCardNumber>sample string 1</MaskedCardNumber> </CreditCard>