POST v1/ProfilePersons/{id}/SavedPaymentMethods/GetRemotePaymentRequest

Create SPM by remote hosted payment method. Returns remote URL to add payment details.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

CreatePersonRemoteSavedPaymentInput
NameDescriptionTypeAdditional information
expirationMonth

integer

Required

expirationYear

integer

Required

Request Formats

application/json, text/json

Sample:
{
  "expirationMonth": 1,
  "expirationYear": 2
}

text/html

Sample:
{"expirationMonth":1,"expirationYear":2}

application/xml, text/xml

Sample:
<v1_ProfilePersons_ProfilePersonEndpointController.CreatePersonRemoteSavedPaymentInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aptify.Services.Generated.v1_ProfilePersons_ProfilePersonEndpoint">
  <expirationMonth>1</expirationMonth>
  <expirationYear>2</expirationYear>
</v1_ProfilePersons_ProfilePersonEndpointController.CreatePersonRemoteSavedPaymentInput>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CreatePersonRemoteSavedPaymentInput'.

Response Information

Resource Description

personSPMRemoteOutput
NameDescriptionTypeAdditional information
outputPaymentURL

The generated request data for adding remote SPM.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "outputPaymentURL": "sample string 1"
}

text/html

Sample:
{"outputPaymentURL":"sample string 1"}

application/xml, text/xml

Sample:
<v1_ProfilePersons_ProfilePersonEndpointController.personSPMRemoteOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aptify.Services.Generated.v1_ProfilePersons_ProfilePersonEndpoint">
  <outputPaymentURL>sample string 1</outputPaymentURL>
</v1_ProfilePersons_ProfilePersonEndpointController.personSPMRemoteOutput>