账款应收款业务

本节描述的操作使你能够执行应收账款操作

获取账户平衡

Get/V2/ccounts/{ran}/

获取账户平衡

请求

请求有下列URI和标题参数:

名称	类型	描述性
{ran}	URI字符串	帐号
X-AUT-Token	页眉字符串	有效认证令牌关联
接受	页眉字符串	值:应用/json

操作不接受请求体

响应

实例获取账户平衡:JSON响应

{平衡度:{{{untleduce>:1500.25}lentBalance:1510.75,pastdue:105.

本表显示此操作可能的响应码 :

响应码	名称	描述性
二百	好	请求成功
400	坏请求	泛报出错
401	未授权	请求未被应用, 因为它缺少目标资源有效认证证书。证书过期或无效
404	未找到	服务器找不到请求内容。
405	方法不允许	请求行中接收的方法为源服务器所知,但目标资源不支持
406	不可接受	服务器无法生成匹配请求中定义的可接受值列表响应
415	无支持媒体类型	错误介质类型用于cURL请求时可能导致错误
500	内部服务器错误	服务器遇到意外条件,无法满足请求

拥有下列任一角色的用户可访问该API:

identity:user-admin
管理员
计费单:admin
观察者
billing:observer

获取计费摘要

GET /v2/accounts/{ran}/billing-summary

获取帐单汇总

请求

请求有下列URI和标题参数:

名称	类型	描述性
{ran}	URI字符串	帐号
X-AUT-Token	页眉字符串	有效认证令牌关联
接受	页眉字符串	值:应用/json

本表显示请求查询参数

名称	类型	描述性
限值	整数	整数介于1到200间,指定要返回记录数默认限值为25记录了解更多页码规则参考段挂起集合.
标识符	整数	0和结果列表最后项间整数
启动日期	日期显示	字符串指定交易起始日期未提供时,从当前日期计为两年计费汇总响应受限自此日期开始的时段日期必须在UTC表示日期格式为ISO8601YYYYY-MM-DD
端点日期	日期显示	字符串指定交易结束日期结束日期必须在起始日期后未提供时默认当前日期计费汇总响应受限至此日期结束时间段日期必须在UTC表示起始日期必须小于或等于结束日期日期格式为ISO8601YYYYY-MM-DD

操作不接受请求体

响应

示例收费摘要:JSON响应

华体会联盟hth{   "billingSummary": {     "item": [       {         "id": "cfc42488-0ce2-4068-b39a-1892438f418f",         "openBalance": "23.55",         "tranRefNum": "A1-12345",         "date": "2013-05-26T16:32:52.000-05:00",         "amount": "296.75",         "status": "OPEN",         "type": "CREDIT",         "link": [           {             "rel": "self",             "href": "https://billing.api.rackspacecloud.com/v2/accounts/{ran}/adjustments/{adjustmentId}"           }         ]       },       {         "id": "d19b0bfa-862d-4bbe-a38c-c8cac997f083",         "openBalance": "23.55",         "tranRefNum": "B1-12345",         "date": "2013-05-26T15:32:52.000-05:00",         "amount": "296.75",         "coverageEndDate": "2018-07-28T00:00:00Z",         "coverageStartDate": "2018-06-28T00:00:00Z",         "status": "OPEN",         "type": "INVOICE",         "link": [           {             "rel": "self",             "href": "https://billing.api.rackspacecloud.com/v2/accounts/{ran}/invoices/{invoiceId}"           }         ]       },       {         "id": "0d81bfc6-91bf-4c60-9821-4ad2e581bfc6",         "openBalance": "101.01",         "tranRefNum": "A1-4503",         "date": "2018-07-05T05:15:44Z",         "amount": "101.01",         "status": "OPEN",         "type": "REFUND",         "link": [           {             "href": "https://billing.api.rackspacecloud.com/v2/accounts/${ran}/refunds/{refundId}",             "rel": "self"           }         ]       },       {         "id": "9043be0f-a0a7-4d8a-b165-bb722bc19243",         "openBalance": "23.55",         "tranRefNum": "P1-123456123",         "date": "2013-06-01T21:32:52.000-05:00",         "amount": "355.50",         "status": "CLOSED",         "type": "PAYMENT",         "link": [           {             "rel": "self",             "href": "https://billing.api.rackspacecloud.com/v2/accounts/{ran}/payments/{paymentId}"           }         ]       }     ],     "total": 12345,     "link": [       {         "rel": "prev",         "href": "https://billing.api.rackspacecloud.com/v2/accounts/{ran}/billing-summary?marker=30&limit=15"       },       {         "rel": "next",         "href": "https://billing.api.rackspacecloud.com/v2/accounts/{ran}/billing-summary?marker=45&limit=15"       }     ],     "currency": "USD",     "accountNumber": "{ran}"   } }

本表显示此操作可能的响应码 :

响应码	名称	描述性
二百	好	请求成功
400	坏请求	泛报出错
401	未授权	请求未被应用, 因为它缺少目标资源有效认证证书。证书过期或无效
404	未找到	服务器找不到请求内容。
405	方法不允许	请求行中接收的方法为源服务器所知,但目标资源不支持
406	不可接受	服务器无法生成匹配请求中定义的可接受值列表响应
415	无支持媒体类型	错误介质类型用于cURL请求时可能导致错误
500	内部服务器错误	服务器遇到意外条件,无法满足请求

拥有下列任一角色的用户可访问该API:

identity:user-admin
管理员
计费单:admin
观察者
billing:observer

本表显示每种事务类型可能的状态值

事务类型	状态
发票	开放关闭
信用或借方	开放关闭
支付	平面关闭
退款	开关关关
逆序变换	开放关闭

取发票

GET /v2/accounts/{ran}/invoices/{invoiceId}

获取发票识别发票ID.

调用返回HTTP202文档尚未准备客户消化时出错。代码表示文档暂时无法使用,客户晚点再试有效值发票ld内含B1,B1-PO并S1.

请求

请求有下列URI和标题参数:

名称	类型	描述性
{ran}	URI字符串	帐号
{invoiceId}	URI字符串	发票标识符
X-AUT-Token	页眉字符串	有效认证令牌关联
接受	页眉字符串	值:应用/json应用/pdf

操作不接受请求体

响应

实例获取发票:JSON响应

华体会联盟hth{备注}:{####01#######################################0P.O.Box 730759 Dallas,",     "currency": "USD",     "id": "7dc53df5-703e-49b3-8670-b1c468f47f1f",     "paymentTerms": "Due upon receipt",     "invoiceSection": [       {         "invoiceItem": [           {             "itemType": "PRODUCT_CHARGES",             "itemAmount": "21.61",             "name": "Cloud Servers",             "id": "0f35a016-2ea1-4ea3-8399-0fe3601d5bac"           },           {             "itemType": "SUPPORT_CHARGES",             "itemAmount": "828.23",             "name": "Managed Infrastructure",             "id": "0439a07e-6f9b-439e-9256-c051b3ab7a12"           },           {             "itemType": "OTHER_CHARGES",             "itemAmount": "20.01",             "name": "Bulk File importing",             "id": "0439a07e-6f9b-439e-9256-c051b3ab7a1f"           }         ],         "sectionId": "{ran}",         "sectionType": "ACCOUNT_NUMBER"       }     ],     "invoiceContact": [       {         "address": {           "zip": "75373-0759",           "country": "United States",           "city": "Austin",           "addressLine1": "64 Austin HWY",           "state": "TX"         },         "name": "Mary Silva",         "contactType": "BILLER"       },       {         "address": {           "zip": "78218",           "country": "United States",           "city": "San Antonio",           "addressLine1": "320 Basse Rd",           "state": "TX"         },         "name": "ESPN Sports",         "contactType": "BILL_TO_PRIMARY"       }     ],     "status": "OPEN"   } }

样本JSON订货

if发票ld请求中为 PO数,下文部分响应显示请求中相异部分tranRefNum起始语B1-PO-和浮点数即时

{注解:{.TranRefNum:B1-PO-123456785,PONOF2D2F5V58F.}}

JSON样本声明

if发票ld请求中表示语句,以下部分响应显示请求中不同部分tranRefNum起始语S1-.

{注解:{..tranRefNum:S1-123456785..}}

本表显示此操作可能的响应码 :

响应码	名称	描述性
二百	好	请求成功
202	接受	文档尚不准备客户消化
400	坏请求	泛报出错
401	未授权	请求未被应用, 因为它缺少目标资源有效认证证书。证书过期或无效
404	未找到	服务器找不到请求内容。
405	方法不允许	请求行中接收的方法为源服务器所知,但目标资源不支持
406	不可接受	服务器无法生成匹配请求中定义的可接受值列表响应
415	无支持媒体类型	错误介质类型用于cURL请求时可能导致错误
500	内部服务器错误	服务器遇到意外条件,无法满足请求

拥有下列任一角色的用户可访问该API:

identity:user-admin
管理员
计费单:admin
观察者
billing:observer

获取当前发票

GET /v2/accounts/{ran}/invoices/latest

获取最新(最新或当前)发票运算返回发票格式接受页眉传递

调用返回HTTP202文档尚未准备客户消化时出错。代码表示文档暂时无法使用,客户应再试一次

请求

请求有下列URI和标题参数:

名称	类型	描述性
{ran}	URI字符串(必备)	帐号
X-AUT-Token	页眉字符串	有效认证令牌关联
接受	页眉字符串	值:应用/json应用/pdf

操作不接受请求体

响应

实例获取当前发票:JSON响应

华体会联盟hth{   "invoice": {     "date": "2013-05-01T16:32:52.000-05:00",     "accountName": "ESPN Sports",     "invoiceSubTotal": "600.02",     "dueDate": "2013-04-30T19:00:00.000-05:00",     "taxTotal": "10.01",     "consolidatedAccountNumber": "EBS123456",     "coverageEndDate": "2013-04-30T16:32:52.000-05:00",     "invoiceTotal": "600.01",     "coverageStartDate": "2013-04-01T16:32:52.000-05:00",     "tranRefNum": "B1-123456785",     "discountTotal": "20.02",     "invoiceSection": [       {         "invoiceItem": [           {             "itemType": "PRODUCT_CHARGES",             "itemAmount": "21.61",             "name": "Cloud Servers",             "id": "0f35a016-2ea1-4ea3-8399-0fe3601d5bac"           },           {             "itemType": "SUPPORT_CHARGES",             "itemAmount": "828.23",             "name": "Managed Infrastructure",             "id": "0439a07e-6f9b-439e-9256-c051b3ab7a12"           },           {             "itemType": "OTHER_CHARGES",             "itemAmount": "20.01",             "name": "Bulk File importing",             "id": "0439a07e-6f9b-439e-9256-c051b3ab7a1f"           }         ],         "sectionId": "{ran}",         "sectionType": "ACCOUNT_NUMBER"       }     ],     "sellerOfRecordInfo": "Rackspace US, Inc.P.O.Box 730759 Dallas,",     "currency": "USD",     "id": "7dc53df5-703e-49b3-8670-b1c468f47f1f",     "paymentTerms": "Due upon receipt",     "invoiceContact": [       {         "address": {           "zip": "75373-0759",           "country": "United States",           "city": "Austin",           "addressLine1": "64 Austin HWY",           "state": "TX"         },         "name": "Mary Silva",         "contactType": "BILLER"       },       {         "address": {           "zip": "78218",           "country": "United States",           "city": "San Antonio",           "addressLine1": "320 Basse Rd",           "state": "TX"         },         "name": "ESPN Sports",         "contactType": "BILL_TO_PRIMARY"       }     ],     "status": "OPEN"   } }

JSON样本中当前发票为购货订单

if计费账户PO有最新发票,下文部分回复显示相异部分上头tranRefNum起始语B1-PO并浮点数内含。

{注解:{..TranRefNum:B1-PO-123456785,PONOF2D2F5V58F..}}

JSON样本当前发票说明

if计费账户拥有最新发票报表,以下部分响应显示相异部分上头tranRefNum起始语S1-.

{注解:{..tranRefNum:S1-123456785..}}

本表显示此操作可能的响应码 :

响应码	名称	描述性
二百	好	请求成功
202	接受	文档尚不准备客户消化
400	坏请求	泛报出错
401	未授权	请求未被应用, 因为它缺少目标资源有效认证证书。证书过期或无效
404	未找到	服务器找不到请求内容。
405	方法不允许	请求行中接收的方法为源服务器所知,但目标资源不支持
406	不可接受	服务器无法生成匹配请求中定义的可接受值列表响应
415	无支持媒体类型	错误介质类型用于cURL请求时可能导致错误
500	内部服务器错误	服务器遇到意外条件,无法满足请求

拥有下列任一角色的用户可访问该API:

identity:user-admin
管理员
计费单:admin
观察者
billing:observer

获取详细计费报表

GET /v2/accounts/{ran}/invoices/{invoiceId}/detail

获取详细计费报表一张发票电话还提供更多细节,提高发票可见度

调用返回HTTP202文档尚未准备客户消化时出错。代码表示文档暂时无法使用,客户应再试一次

请求

请求有下列URI和标题参数:

名称	类型	描述性
{ran}	URI字符串	帐号
{invoiceId}	URI字符串	发票标识符
X-AUT-Token	页眉字符串	有效认证令牌关联
接受	页眉字符串	值:文本/csv

操作不接受请求体

响应

操作返回CSV内容/csv响应

实例获取详细收费报表

样本csv响应

ACCOUNT_NO,BILL_NO,BILL_START_DATE,BILL_END_DATE,SERVICE_TYPE,EVENT_TYPE,EVENT_START_DATE,EVENT_END_DATE,IMPACT_TYPE,QUANTITY,UOM,RATE,AMOUNT,USAGE_RECORD_ID,DC_ID,REGION_ID,RES_ID,RES_NAME,ATTRIBUTE_1,ATTRIBUTE_2,ATTRIBUTE_3 {ran},{billNumber},12/12/2014 0:00,1/12/2015 0:00,Cloud Sites,Other Charges - Subscription,1/12/2015 0:00,1/12/2015 0:00,CHARGE,1,,100/mo,100,,,,,,,, {ran},{billNumber},12/12/2014 0:00,1/12/2015 0:00,ACCOUNT,TAX,1/11/2015 23:59,1/11/2015 23:59,State Tax,100,,,0,,,,,,,, {ran},{billNumber},12/12/2014 0:00,1/12/2015 0:00,ACCOUNT,TAX,1/11/2015 23:59,1/11/2015 23:59,County Tax,100,,,0,,,,,,,, {ran},{billNumber},12/12/2014 0:00,1/12/2015 0:00,ACCOUNT,TAX,1/11/2015 23:59,1/11/2015 23:59,Local Sales Tax,100,,,0,,,,,,,,

下表显示下载发票中需注解的列

OCOUNT_NO
BILL_NO
BILL_START_DATE
BILL_end_Date
Service_TYPE:开单期间使用服务
奇特TYPE:划分每种产品收费或其他收费,并加税额

本表显示此操作可能的响应码 :

响应码	名称	描述性
二百	好	请求成功
202	接受	文档尚不准备客户消化
400	坏请求	泛报出错
401	未授权	请求未被应用, 因为它缺少目标资源有效认证证书。证书过期或无效
404	未找到	服务器找不到请求内容。
405	方法不允许	请求行中接收的方法为源服务器所知,但目标资源不支持
406	不可接受	服务器无法生成匹配请求中定义的可接受值列表响应
415	无支持媒体类型	错误介质类型用于cURL请求时可能导致错误
500	内部服务器错误	服务器遇到意外条件,无法满足请求

拥有下列任一角色的用户可访问该API:

identity:user-admin
管理员
计费单:admin
观察者
billing:observer

查详细计费报表开票

HEAD /v2/accounts/{ran}/invoices/{invoiceId}/detail

检查发票是否可以开帐单报表您应准备处理错误请求(400)故障,处理不符合报告条件的发票

请求

请求有下列URI和标题参数:

名称	类型	描述性
{ran}	URI字符串	帐号
{invoiceId}	URI字符串	发票标识符
X-AUT-Token	页眉字符串	有效认证令牌关联
接受	页眉字符串	值:应用/json

操作不接受请求体

响应

操作不返回响应体

本表显示此操作可能的响应码 :

响应码	名称	描述性
二百	好	请求成功
400	坏请求	泛报出错
401	未授权	请求未被应用, 因为它缺少目标资源有效认证证书。证书过期或无效
404	未找到	服务器找不到请求内容。
405	方法不允许	请求行中接收的方法为源服务器所知,但目标资源不支持
406	不可接受	服务器无法生成匹配请求中定义的可接受值列表响应
415	无支持媒体类型	错误介质类型用于cURL请求时可能导致错误
500	内部服务器错误	服务器遇到意外条件,无法满足请求

拥有下列任一角色的用户可访问该API:

identity:user-admin
管理员
计费单:admin
观察者
billing:observer

获取调整

GET /v2/accounts/{ran}/adjustments/{adjustmentId}

获取调整细节调整Id.

调用返回HTTP202文档尚不准备客户消费代码表示文档暂时无法使用,客户应再试一次

请求

请求有下列URI和标题参数:

名称	类型	描述性
{ran}	URI字符串	帐号
{调整Id}	URI字符串	调整标识符
X-AUT-Token	页眉字符串	有效认证令牌关联
接受	页眉字符串	值:应用/json应用/pdf

操作不接受请求体

响应

实例获取调整:JSON响应

{   "adjustment": {     "itemReferences": {       "itemReference": [         {           "tranRefNum": "A1-1234567",           "amountApplied": "20.0",           "tranDate": "2013-05-26T16:32:52.000-05:00",           "id": "68bcaeb0-d486-4637-a6c8-846d401be419",           "type": "DEBIT_ADJ"         }       ]     },     "amount": "22.65",     "tranRefNum": "A1-1234564",     "currency": "USD",     "reasonCode": "Uptime SLA",     "tranDate": "2013-08-26T16:32:52.000-05:00",     "id": "6e0004cb-f0bd-4085-8419-5ee3fc980aad",     "type": "CREDIT",     "status": "POSTED"   } }

本表显示此操作可能的响应码 :

响应码	名称	描述性
二百	好	请求成功
202	接受	文档尚不准备客户消化
400	坏请求	泛报出错
401	未授权	请求未被应用, 因为它缺少目标资源有效认证证书。证书过期或无效
404	未找到	服务器找不到请求内容。
405	方法不允许	请求行中接收的方法为源服务器所知,但目标资源不支持
406	不可接受	服务器无法生成匹配请求中定义的可接受值列表响应
415	无支持媒体类型	错误介质类型用于cURL请求时可能导致错误
500	内部服务器错误	服务器遇到意外条件,无法满足请求

拥有下列任一角色的用户可访问该API:

identity:user-admin
管理员
计费单:admin
观察者
billing:observer

获取支付

GET /v2/accounts/{ran}/payments/{paymentId}

获取付款识别支付Id.

请求

请求有下列URI和标题参数:

名称	类型	描述性
{ran}	URI字符串	帐号
{支付Id}	URI字符串	支付标识符
X-AUT-Token	页眉字符串	有效认证令牌关联
接受	页眉字符串	值:应用/json

操作不接受请求体

响应

实例通过身份证获取支付细节信用卡支付:JSON响应

{   "payment": {     "amount": "-22.65",     "gatewayTxRefNum": "4C3213241331117CD265DE7ADA3967A15218542B",     "methodId": "urn:uuid:fa093563-73db-4fe4-8f3a-def53dde8f5d",     "submissionDate": "2013-05-26T16:32:52.000-05:00",     "transactionId": "T1,123456,1",     "itemReferences": {       "itemReference": [         {           "tranRefNum": "B1-1234567",           "amountApplied": "10.0",           "tranDate": "2013-04-26T07:32:52.000-05:00",           "id": "12bcaeb0-d486-4637-a6c8-846d401be000",           "type": "INVOICE"         },         {           "tranRefNum": "A1-1234567",           "amountApplied": "5.0",           "tranDate": "2013-05-26T16:06:22.000-05:00",           "id": "34bcaeb0-d486-4637-a6c8-846d401be555",           "type": "DEBIT_ADJ"         }       ]     },     "tranRefNum": "P1-1234564",     "methodType": "CREDITCARD",     "currency": "USD",     "paymentMethodDetails": {       "paymentCard": {         "cardType": "VISA",         "ccExpiry": "12/16",         "ccLast4": "6007",         "ccHolderName": "Joe Doe"       }     },     "id": "6e81bfc6-81bf-4c68-8ae2-7ad2e58641f6",     "responseMessage": "Approved",     "status": "CLOSED"   } }

JSON样本自动交换所支付

if支付Id请求中为ACH支付类型,下文部分响应显示请求中不同部分

{支付:{..metrodType :ACH,Chtright-81bf4c68-8ae2-7ad2641f6

JSON样本支付UK直接Debit

if支付Id请求中为UK直接 Debit支付类型,下文部分响应显示此请求的不同部分

{支付:{..methodType:UKDD,计算方式:GP,支付方法学Debits:{UkDERDETDEDEDEDEDETS####BankSortCode:#6006#BankAccountNe

JSON样本与荷兰单欧支付区

if支付Id请求中为荷兰单欧支付区支付类型,下文部分回复显示请求中不同部分

{支付:{..methodType:NLESEPA,Force2-7ad2641f6,SefferationMessage:Acjected

JSON样本支付锁框/检查

if支付Id请求中为 Lockbox/Check支付类型,以下部分响应显示请求的不同部分

{支付:{..methodType:Lockbox,Chetype:ChCK,Ccounte数:00BC6-81bf-CE2-7A2-7A226f6

JSON样本使用 Lockbox/Wire支付

if支付Id请求中为 Lockbox/Wire支付类型,下文部分响应显示请求的不同部分

{支付:{..metrodType:LOCBOX,Formtrodype:USD,支付方法细节:{lockboxPayment#{RuetingNu

JSON样本与Lockbox/ACH支付

if支付Id请求中为 Lockbox/ACH支付类型,下文部分响应显示请求的不同部分

{支付:{..metrodType:LOCBOX,Controductions:USD,支付方法细节:{lockboxPayment#{RouringNuble:N01234567#lockboxNe

本表显示此操作可能的响应码 :

响应码	名称	描述性
二百	好	请求成功
400	坏请求	泛报出错
401	未授权	请求未被应用, 因为它缺少目标资源有效认证证书。证书过期或无效
404	未找到	服务器找不到请求内容。
405	方法不允许	请求行中接收的方法为源服务器所知,但目标资源不支持
406	不可接受	服务器无法生成匹配请求中定义的可接受值列表响应
415	无支持媒体类型	错误介质类型用于cURL请求时可能导致错误
500	内部服务器错误	服务器遇到意外条件,无法满足请求

拥有下列任一角色的用户可访问该API:

identity:user-admin
管理员
计费单:admin
观察者
billing:observer

取表支付一张发票

GET /v2/accounts/{ran}/invoices/{invoiceId}/payments

返回列表支付发票ld.

请求

请求有下列URI和标题参数:

名称	类型	描述性
{ran}	URI字符串	帐号
{invoiceId}	URI字符串	发票标识符
X-AUT-Token	页眉字符串	有效认证令牌关联
接受	页眉字符串	值:应用/json

操作不接受请求体

响应

示例查找支付表发票:JSON响应

{   "payments": {     "payment": [       {         "amount": "-22.65",         "gatewayTxRefNum": "4C3213241331117CD265DE7ADA3967A15218542B",         "methodId": "urn:uuid:fa093563-73db-4fe4-8f3a-def53dde8f5d",         "submissionDate": "2013-05-26T16:32:52.000-05:00",         "transactionId": "T1,123456,1",         "itemReferences": {           "itemReference": [             {               "tranRefNum": "B1-1234567",               "amountApplied": "10.0",               "tranDate": "2013-04-26T07:32:52.000-05:00",               "id": "12bcaeb0-d486-4637-a6c8-846d401be000",               "type": "INVOICE"             }           ]         },         "tranRefNum": "P1-1234564",         "methodType": "CREDITCARD",         "currency": "USD",         "paymentMethodDetails": {           "paymentCard": {             "cardType": "VISA",             "ccExpiry": "12/16",             "ccLast4": "6007",             "ccHolderName": "Joe Doe"           }         },         "id": "6e81bfc6-81bf-4c68-8ae2-7ad2e58641f6",         "responseMessage": "Approved",         "status": "CLOSED"       },       {         "amount": "-22.65",         "gatewayTxRefNum": "4C3213241331117CD265DE7ADA3967A15218542B",         "methodId": "urn:uuid:fa093563-73db-4fe4-8f3a-def53dde8f5d",         "submissionDate": "2013-05-26T16:32:52.000-05:00",         "transactionId": "T1,123450,1",         "itemReferences": {           "itemReference": [             {               "tranRefNum": "B1-1234567",               "amountApplied": "17.65",               "tranDate": "2013-04-26T07:32:52.000-05:00",               "id": "12bcaeb0-d486-4637-a6c8-846d401be000",               "type": "INVOICE"             },             {               "tranRefNum": "D1-1234567",               "amountApplied": "5.0",               "tranDate": "2013-05-26T16:06:22.000-05:00",               "id": "34bcaeb0-d486-4637-a6c8-846d401be555",               "type": "DEBIT_ADJ"             }           ]         },         "tranRefNum": "P1-1211111",         "methodType": "ACH",         "currency": "USD",         "paymentMethodDetails": {           "electronicCheck": {             "routingNumber": "001234567",             "accountNumber": "0000",             "accountHolderName": "Check Rich"           }         },         "id": "6e81bfc6-81bf-4c68-8ae2-7ad2e58641f6",         "status": "CLOSED"       }     ],     "link": [],     "total": "6"   } }

本表显示此操作可能的响应码 :

响应码	名称	描述性
二百	好	请求成功
400	坏请求	泛报出错
401	未授权	请求未被应用, 因为它缺少目标资源有效认证证书。证书过期或无效
404	未找到	服务器找不到请求内容。
405	方法不允许	请求行中接收的方法为源服务器所知,但目标资源不支持
406	不可接受	服务器无法生成匹配请求中定义的可接受值列表响应
415	无支持媒体类型	错误介质类型用于cURL请求时可能导致错误
500	内部服务器错误	服务器遇到意外条件,无法满足请求

拥有下列任一角色的用户可访问该API:

identity:user-admin
管理员
计费单:admin
观察者
billing:observer

取退

GET /v2/accounts/{ran}/refunds/{refundId}

取退款退款Id.

请求

请求有下列URI和标题参数:

名称	类型	描述性
{ran}	URI字符串	帐号
{fundId}	URI字符串	退款标识符
X-AUT-Token	页眉字符串	有效认证令牌关联
接受	页眉字符串	值:应用/json

操作不接受请求体

响应

示例通过ID退款(检查):JSON响应

{   "refund": {     "amount": "10.45",     "gatewayTxRefNum": "5098B66B8741F2E4A38B24F103150B3AEA8A530E",     "methodId": "urn:uuid:fa093563-73db-4fe4-8f3a-def53dde8f5d",     "itemReferences": {       "itemReference": [         {           "tranRefNum": "P1-1234567",           "amountApplied": "20.0",           "tranDate": "2011-04-26T07:32:52.000-05:00",           "id": "12bcaeb0-d486-4637-a6c8-846d401be000",           "type": "PAYMENT"         }       ]     },     "tranRefNum": "A1-1234561",     "methodType": "CHECK",     "currency": "USD",     "paymentMethodDetails": {       "checkPayment": {         "checkNumber": "000111222",         "accountNumber": "0000"       }     },     "tranDate": "2013-05-26T16:32:52.000-05:00",     "id": "cfc42488-0ce2-4068-b39a-1892438f418f",     "reasonCode": "Check refund",     "status": "CLOSED"   } }

JSON样本退款

if退款Id请求中为ACH支付类型,下文部分响应显示请求的不同部分

{复元:{..tranRefnum:A1-234561,方法ype:ACH,计算方式:USD,支付方法细节..}}

本表显示此操作可能的响应码 :

响应码	名称	描述性
二百	好	请求成功
400	坏请求	泛报出错
401	未授权	请求未被应用, 因为它缺少目标资源有效认证证书。证书过期或无效
404	未找到	服务器找不到请求内容。
405	方法不允许	请求行中接收的方法为源服务器所知,但目标资源不支持
406	不可接受	服务器无法生成匹配请求中定义的可接受值列表响应
415	无支持媒体类型	错误介质类型用于cURL请求时可能导致错误
500	内部服务器错误	服务器遇到意外条件,无法满足请求

拥有下列任一角色的用户可访问该API:

identity:user-admin
管理员
计费单:admin
观察者
billing:observer

获取反转

GET /v2/accounts/{ran}/reversals/{reversalId}

获取反向识别逆序Id.

请求

请求有下列URI和标题参数:

名称	类型	描述性
{ran}	URI字符串	帐号
{反向Id}	URI字符串	逆向标识符
X-AUT-Token	页眉字符串	有效认证令牌关联
接受	页眉字符串	值:应用/json

操作不接受请求体

响应

实例通过ID获取支付回转CC支付:JSON响应

{   "reversal": {     "amount": "10.45",     "itemReferences": {       "itemReference": [         {           "tranRefNum": "P1-1234567",           "amountApplied": "20.0",           "tranDate": "2011-04-26T07:32:52.000-05:00",           "id": "12bcaeb0-d486-4637-a6c8-846d401be000",           "type": "PAYMENT"         }       ]     },     "tranRefNum": "P1-1234567",     "methodType": "CREDITCARD",     "paymentId": "b153650f-a293-41f1-988d-1b7cf7d3fbed",     "currency": "USD",     "paymentMethodDetails": {       "paymentCard": {         "cardType": "VISA",         "ccExpiry": "12/16",         "ccLast4": "6007",         "ccHolderName": "Joe Doe"       },       "paymentId": "urn:uuid:696c40a0-c3e7-11e2-8b8b-0800200c9a66"     },     "tranDate": "2013-05-26T16:32:52.000-05:00",     "id": "6e0004cb-f0bd-4085-8419-5ee3fc980aad",     "reasonCode": "Merchant initiated chargeback",     "status": "APPROVED"   } }

JSON样本反转ACH

if逆序Id请求中为ACH支付类型,下文部分响应显示请求的不同部分

{反向:{..方法类型 : ACH, 货币 : USD, 支付方法细节 : {电子查号 :N01234567,CcountType :PERSONAL-CHECKING..}}

JSON样本反转 Lockbox/Check

if逆序Id请求中为 Lockbox/Check支付类型,以下部分响应显示请求的不同部分

{反向:{..metrodType:lockbox,lockboxype:scountmetDayments:{lockboxPayment's..}}

JSON样本反转 Lockbox/ACH

if逆序Id请求中为 Lockbox/ACH支付类型,下文部分响应显示请求的不同部分

{反向:{..methodDessions:{lockboxPay..}}

JSON样本反锁框/Wire

if逆序Id请求中为 Lockbox/Wire支付类型,下文部分响应显示请求的不同部分

{反向:{..methodDessions:{lockboxPay..}}

JSON样本反向UKDD支付

if逆序Id请求中为UKDD支付类型,下文部分响应显示请求的不同部分

{反向:{..methoddebility:{{bankSortCode>#0123131_bankAccountNations#xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx..}}

JSON样本反转NLSEPA支付

if逆序Id请求中为NLSEPA支付类型,下文部分响应显示请求的不同部分

{反向:{..methodDelects:{支付Idd:urn:Uid:696c40a0-c3e7-11e2-8b-0800c966}{iban#..}}

本表显示此操作可能的响应码 :

响应码	名称	描述性
二百	好	请求成功
400	坏请求	泛报出错
401	未授权	请求未被应用, 因为它缺少目标资源有效认证证书。证书过期或无效
404	未找到	服务器找不到请求内容。
405	方法不允许	请求行中接收的方法为源服务器所知,但目标资源不支持
406	不可接受	服务器无法生成匹配请求中定义的可接受值列表响应
415	无支持媒体类型	错误介质类型用于cURL请求时可能导致错误
500	内部服务器错误	服务器遇到意外条件,无法满足请求

拥有下列任一角色的用户可访问该API:

identity:user-admin
管理员
计费单:admin
观察者
billing:observer